ui/build/collection-filter/collection-filter-inference

Interfaces

CollectionFilterInferenceAnswer

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:27

Properties

conditions

readonly conditions: readonly CollectionFilterInferenceCondition[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:28

unresolved

readonly unresolved: readonly string[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:29

---

CollectionFilterInferenceCondition

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:16

One builder row, in or out of an inference.

Properties

field

readonly field: string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:17

operator

readonly operator: string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:18

value?

readonly optional value?: unknown;

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:19

---

CollectionFilterInferenceField

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:3

One field the picker offers, described for a model: what a condition on it may say.

Properties

array?

readonly optional array?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:8

fields?

readonly optional fields?: readonly CollectionFilterInferenceField[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:13

A relationship's own fields, for the conditions of a related answer.

kind

readonly kind: string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:6

label

readonly label: string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:5

nullable

readonly nullable: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:7

operators

readonly operators: readonly string[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:11

target?

readonly optional target?: string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:10

value

readonly value: string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:4

values?

readonly optional values?: readonly string[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:9

---

CollectionFilterInferenceRequest

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:21

Properties

collection

readonly collection: string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:22

current

readonly current: readonly CollectionFilterInferenceCondition[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:25

fields

readonly fields: readonly CollectionFilterInferenceField[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:24

text

readonly text: string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:23

Type Aliases

CollectionFilterInfer

type CollectionFilterInfer = (request, signal?) => Effect.Effect<CollectionFilterInferenceAnswer, Error>;

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:35

Turns a description into filter rows. Supplied by the host that mounted the collection; absent, the builder offers no composer and stays the manual one it always was.

Parameters

Parameter	Type
request	CollectionFilterInferenceRequest
signal?	AbortSignal

Returns

Effect.Effect<CollectionFilterInferenceAnswer, Error>

Functions

getCollectionFilterInference()

function getCollectionFilterInference():
  | CollectionFilterInfer
  | undefined;

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:36

Returns

| CollectionFilterInfer | undefined

---

setCollectionFilterInference()

function setCollectionFilterInference(infer): void;

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-inference.d.ts:37

Parameters

Parameter	Type
infer	CollectionFilterInfer

Returns

void