Function mutatingStep

Utility function for a step that always modifies the text

Not recommended to use if a step doesn't ALWAYS modify the text.

Example

type TextWrapperStorage = { wrapText: (text: string) => string };

const trimStep = mutatingStep<TextWrapperStorage>(
  ({ text, storage: { wrapText } }) => wrapText(text.trim())
);
// is equivalent to
const trimStep: TaraskStep<TextWrapperStorage> = (ctx) => {
  ctx.text = options.storage.wrapText(
    ctx.text.trim()
  );
};
  • mutatingStep<TStorage>(callback): TaraskStep<TStorage>

  • Type Parameters

    • TStorage extends object = object

    Parameters

    • callback: ((...args: [context: {
          cfg: {
              abc: {
                  lower: CallableDict<RegExp>;
                  upper?: CallableDict<RegExp>;
              };
              doEscapeCapitalized: boolean;
              g: boolean;
              j: OptionJ;
              leftAngleBracket: string;
              newLine: string;
              noFixPlaceholder: string;
              variations: Variation;
              wrappers: null | {
                  fix?: TransformString;
                  letterH?: TransformString;
                  variable?: {
                      all: TransformString;
                      first: TransformString;
                      no: TransformString;
                  };
              };
          };
          storage: TStorage;
          text: string;
      }]) => string)
        • (...args): string

        • Parameters

          • Rest...args: [context: {
                cfg: {
                    abc: {
                        lower: CallableDict<RegExp>;
                        upper?: CallableDict<RegExp>;
                    };
                    doEscapeCapitalized: boolean;
                    g: boolean;
                    j: OptionJ;
                    leftAngleBracket: string;
                    newLine: string;
                    noFixPlaceholder: string;
                    variations: Variation;
                    wrappers: null | {
                        fix?: TransformString;
                        letterH?: TransformString;
                        variable?: {
                            all: TransformString;
                            first: TransformString;
                            no: TransformString;
                        };
                    };
                };
                storage: TStorage;
                text: string;
            }]

          Returns string

    Returns TaraskStep<TStorage>

Settings

Member Visibility