Function createFieldDefinition

  • Create a MessageDefinition object while coercing it's type

    Returns

    a strongly typed message definition

    Example

    const IsoDefinition = createFieldDefinition({"2": {name: "PAN", field: AN({length: 19})}});
    

    Type Parameters

    Parameters

    • messageDef: MessageDefinition<FD>

      an object that define the fields of the ISO message. It's type will be used as the base to type the result of this function and provide type safety

    Returns {
        createNewMessage: ((mti: number) => Message<FD>);
        fields: FD;
        mtiField: Field<number>;
        parse: ((iso: Buffer) => Message<FD>);
        prepare: ((message: Message<FD>) => Buffer);
    }

    • createNewMessage: ((mti: number) => Message<FD>)
        • (mti: number): Message<FD>
        • Parameters

          • mti: number

          Returns Message<FD>

    • fields: FD
    • mtiField: Field<number>
    • parse: ((iso: Buffer) => Message<FD>)
        • (iso: Buffer): Message<FD>
        • Parameters

          • iso: Buffer

          Returns Message<FD>

    • prepare: ((message: Message<FD>) => Buffer)
        • (message: Message<FD>): Buffer
        • Parameters

          Returns Buffer

Generated using TypeDoc