Class RoocRunnablePipe

constructor

• new RoocRunnablePipe(): RoocRunnablePipe

  Returns RoocRunnablePipe

instance

addPipeByName

• addPipeByName(pipe: Pipes): void

  Parameters

  • pipe: Pipes

  Returns void

addPipe

• addPipe(cb: (data: JsPipableData) => JsPipableData): void

  Parameters

  • cb: (data: JsPipableData) => JsPipableData

  Returns void

run

• run(
      source: string,
      data?: ConstantEntry[],
      fns?: RoocFunction<[string, SerializedPrimitiveKind][]>[],
  ): Result<RoocData[], { error: string; context: RoocData[] }>

  Run the pipe on a source code

  Parameters

  • source: string

    the source code to run the pipe on

  • data: ConstantEntry[] = []

    additional data provided to the runtime

  • fns: RoocFunction<[string, SerializedPrimitiveKind][]>[] = []

    additional functions that can be used in the transformation process

  Returns Result<RoocData[], { error: string; context: RoocData[] }>

  each step of the pipe returns some data, if there was an error, it's previous context is returned too