@cbnsndwch/zero-sources

isPipelineMapping() function

Home > @cbnsndwch/zero-contracts > isPipelineMapping

isPipelineMapping() function

Type guard to check if a table mapping uses the pipeline-based approach.

Signature:

declare function isPipelineMapping<T>(
    mapping: TableMapping<T>
): mapping is PipelineTableMapping<T>;

Parameters

Parameter

Type

Description

mapping

TableMapping<T>

The table mapping to check

Returns:

mapping is PipelineTableMapping<T>

True if the mapping uses pipeline, false if it uses simple filter

Example

const mapping: TableMapping = { source: 'accounts', pipeline: [...] };

if (isPipelineMapping(mapping)) {
  // mapping is PipelineTableMapping
  console.log(mapping.pipeline);
}

How was this page?