@tcfoss/filtering-contracts

Documentation | Repository

TypeScript mirror of the TcfOss.Filtering.Contracts wire models and constants.

Install

npm install @tcfoss/filtering-contracts

Optional schema validation:

npm install zod

What this package includes

• Contract types (DataRequest, DynamicDataRequest, DataResult).
• Shared constants (FilterOperators, LogicalOperators, SortDirections, QuantifiedOperators).
• Optional Zod schemas for validating incoming payloads.

Basic usage

import { FilterOperators, SortDirections } from '@tcfoss/filtering-contracts';
import type { DataRequest } from '@tcfoss/filtering-contracts';

const request: DataRequest = {
  filter: { filterType: 'simple', field: 'name', operator: FilterOperators.Contains, value: 'smith' },
  sorts: [{ field: 'name', direction: SortDirections.Ascending }],
  page: 1,
  pageSize: 20,
};

Related docs

• Contract keys
• Repository README