mini-effect
    Preparing search index...

    Interface ParseJsonAction<TInput$1, TConfig, TMessage>Beta

    Parse JSON action interface.

    interface ParseJsonAction<
        TInput$1 extends string,
        TConfig extends ParseJsonConfig | undefined,
        TMessage extends ErrorMessage<ParseJsonIssue<TInput$1>> | undefined,
    > {
        "~run": (
            dataset: SuccessDataset<TInput$1>,
            config: Config<BaseIssue<unknown>>,
        ) => OutputDataset<unknown, BaseIssue<unknown> | ParseJsonIssue<TInput$1>>;
        "~types"?: { input: TInput$1; issue: ParseJsonIssue; output: unknown };
        async: false;
        config: TConfig;
        kind: "transformation";
        message: TMessage;
        reference: {
            <TInput$1 extends string>(): ParseJsonAction<
                TInput$1,
                undefined,
                undefined,
            >;
            <
                TInput$1 extends string,
                const TConfig extends ParseJsonConfig | undefined,
            >(
                config: TConfig,
            ): ParseJsonAction<TInput$1, TConfig, undefined>;
            <
                TInput$1 extends string,
                const TConfig extends ParseJsonConfig | undefined,
                const TMessage extends ErrorMessage<ParseJsonIssue<TInput$1>> | undefined,
            >(
                config: TConfig,
                message: TMessage,
            ): ParseJsonAction<TInput$1, TConfig, TMessage>;
        };
        type: "parse_json";
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    ~run ~types? async config kind message reference type

    Properties

    "~run": (
        dataset: SuccessDataset<TInput$1>,
        config: Config<BaseIssue<unknown>>,
    ) => OutputDataset<unknown, BaseIssue<unknown> | ParseJsonIssue<TInput$1>>

    Transforms known input values.

    Type Declaration

    "~types"?: { input: TInput$1; issue: ParseJsonIssue; output: unknown }

    The input, output and issue type.

    async: false

    Whether it's async.

    config: TConfig

    The action config.

    kind: "transformation"

    The object kind.

    message: TMessage

    The error message.

    reference: {
        <TInput$1 extends string>(): ParseJsonAction<
            TInput$1,
            undefined,
            undefined,
        >;
        <
            TInput$1 extends string,
            const TConfig extends ParseJsonConfig | undefined,
        >(
            config: TConfig,
        ): ParseJsonAction<TInput$1, TConfig, undefined>;
        <
            TInput$1 extends string,
            const TConfig extends ParseJsonConfig | undefined,
            const TMessage extends ErrorMessage<ParseJsonIssue<TInput$1>> | undefined,
        >(
            config: TConfig,
            message: TMessage,
        ): ParseJsonAction<TInput$1, TConfig, TMessage>;
    }

    The action reference.

    Type Declaration

      • <TInput$1 extends string>(): ParseJsonAction<TInput$1, undefined, undefined>
      • Beta

        Creates a parse JSON transformation action.

        Type Parameters

        • TInput$1 extends string

        Returns ParseJsonAction<TInput$1, undefined, undefined>

        A parse JSON action.

      • <TInput$1 extends string, const TConfig extends ParseJsonConfig | undefined>(
            config: TConfig,
        ): ParseJsonAction<TInput$1, TConfig, undefined>
      • Beta

        Creates a parse JSON transformation action.

        Type Parameters

        Parameters

        • config: TConfig

          The action config.

        Returns ParseJsonAction<TInput$1, TConfig, undefined>

        A parse JSON action.

      • <
            TInput$1 extends string,
            const TConfig extends ParseJsonConfig | undefined,
            const TMessage extends ErrorMessage<ParseJsonIssue<TInput$1>> | undefined,
        >(
            config: TConfig,
            message: TMessage,
        ): ParseJsonAction<TInput$1, TConfig, TMessage>
      • Beta

        Creates a parse JSON transformation action.

        Type Parameters

        Parameters

        • config: TConfig

          The action config.

        • message: TMessage

          The error message.

        Returns ParseJsonAction<TInput$1, TConfig, TMessage>

        A parse JSON action.

    type: "parse_json"

    The action type.

    Settings

    Member Visibility

    On This Page

    Properties