Function getStructMetadata

Returns
    | V3.AnyStruct<Custom<any[], string, any>>
    | V3.GenericStruct<T, true, Custom<any[], string, any>>
    | {
        context?: Record<string, any> | null;
        kind?: string;
        optional: boolean;
        rules: {
            args: any[];
            handler: CustomHandler<any[], T>;
            rule: string;
            type: "custom";
        }[];
        schema: TypeGuard<T>;
        type: "custom";
    }

• V3.AnyStruct<Custom<any[], string, any>>
• V3.GenericStruct<T, true, Custom<any[], string, any>>
• {
      context?: Record<string, any> | null;
      kind?: string;
      optional: boolean;
      rules: {
          args: any[];
          handler: CustomHandler<any[], T>;
          rule: string;
          type: "custom";
      }[];
      schema: TypeGuard<T>;
      type: "custom";
  }

  • Optionalcontext?: Record<string, any> | null

    context metadata for the custom struct

  • Optionalkind?: string

    kind of the custom struct's value mapped

  • optional: boolean

  • rules: { args: any[]; handler: CustomHandler<any[], T>; rule: string; type: "custom" }[]

  • schema: TypeGuard<T>

  • type: "custom"

Returns V3.AnyStruct

Returns
    | V3.StructType<Custom<any[], string, any>>
    | {
        context?: Record<string, any> | null;
        kind?: string;
        optional: boolean;
        rules: {
            args: any[];
            handler: CustomHandler<any[], unknown>;
            rule: string;
            type: "custom";
        }[];
        schema: TypeGuard<unknown>;
        type: "custom";
    }

• V3.StructType<Custom<any[], string, any>>
• {
      context?: Record<string, any> | null;
      kind?: string;
      optional: boolean;
      rules: {
          args: any[];
          handler: CustomHandler<any[], unknown>;
          rule: string;
          type: "custom";
      }[];
      schema: TypeGuard<unknown>;
      type: "custom";
  }

  • Optionalcontext?: Record<string, any> | null

    context metadata for the custom struct

  • Optionalkind?: string

    kind of the custom struct's value mapped

  • optional: boolean

  • rules: {
        args: any[];
        handler: CustomHandler<any[], unknown>;
        rule: string;
        type: "custom";
    }[]

  • schema: TypeGuard<unknown>

  • type: "custom"