Function union

  • union<TShape>(name, inner, tags, options?): mol.UnionCodec<TShape>

  • Codec for built-in type union.

    Type Parameters

    Parameters

    • name: string
    • inner: TShape
    • tags: Record<keyof TShape, number> | (keyof TShape)[]
    • Optional options: {
          skipVerification?: boolean;
      }
      • Optional skipVerification?: boolean

    Returns mol.UnionCodec<TShape>

    Example

    const Byte2 = mol.array("Byte2", mol.byte, 2);
    const Byte2x2 = mol.array("Byte2x2", Byte2, 2);
    const Byte4 = mol.array("Byte4", mol.byte, 4);
    const Word = mol.union(
      "Word",
      {
        Byte4,
        Byte2x2,
      },
      ["Byte4", "Byte2x2"],
    );
    const WordCustomTag = mol.union(
      "WordCustomTag",
      {
        Byte4,
        Byte2x2,
      },
      {
        Byte4: 4,
        Byte2x2: 2,
      },
    );

Settings

Member Visibility

Theme

Generated using TypeDoc