Function defineTriggerPayloadSchema

  • defineTriggerPayloadSchema<Params>(definer): TObject<Params>

  • Type Parameters

    • Params extends TProperties

    Parameters

    • definer: ((t) => Params)
        • (t): Params

        • Parameters

          • t: {
                array: (<T>(schema, options?) => TArray<T>);
                boolean: ((options?) => TBoolean);
                nullable: (<T>(schema) => TUnion<[T, TNull]>);
                number: ((options?) => TNumber);
                object: (<T>(properties, options?) => TObject<T>);
                string: ((options?) => TString);
            }
            • array: (<T>(schema, options?) => TArray<T>)
                • <T>(schema, options?): TArray<T>

                • [Json] Creates an Array type

                  Type Parameters

                  • T extends TSchema

                  Parameters

                  • schema: T
                  • Optional options: ArrayOptions

                  Returns TArray<T>

            • boolean: ((options?) => TBoolean)
                • (options?): TBoolean

                • [Json] Creates a Boolean type

                  Parameters

                  • Optional options: SchemaOptions

                  Returns TBoolean

            • nullable: (<T>(schema) => TUnion<[T, TNull]>)
                • <T>(schema): TUnion<[T, TNull]>

                • Type Parameters

                  • T extends TSchema

                  Parameters

                  • schema: T

                  Returns TUnion<[T, TNull]>

            • number: ((options?) => TNumber)
                • (options?): TNumber

                • [Json] Creates a Number type

                  Parameters

                  • Optional options: NumberOptions

                  Returns TNumber

            • object: (<T>(properties, options?) => TObject<T>)
                • <T>(properties, options?): TObject<T>

                • [Json] Creates an Object type

                  Type Parameters

                  • T extends TProperties

                  Parameters

                  • properties: T
                  • Optional options: ObjectOptions

                  Returns TObject<T>

            • string: ((options?) => TString)
                • (options?): TString

                • [Json] Creates a String type

                  Parameters

                  • Optional options: StringOptions

                  Returns TString

          Returns Params

    Returns TObject<Params>