ui/build/collection-surface/collection-surface.types

Interfaces

CollectionInitialFilter

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

An editable filter row a collection surface opens with.

Properties

field

readonly field: string;

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

operator

readonly operator: CollectionFilterOperator;

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

value?

readonly optional value?: unknown;

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

---

CollectionPipeline

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

Type Parameters

Type Parameter	Default type
TRow extends object	-
E	Error

Properties

description?

readonly optional description?: string;

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

getDisabledReason?

readonly optional getDisabledReason?: (selectedRows) => string | null;

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

Parameters

Parameter	Type
selectedRows	readonly TRow[]

Returns

string | null

icon?

readonly optional icon?: string;

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

id

readonly id: string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-surface/collection-surface.types.d.ts:14

label

readonly label: string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-surface/collection-surface.types.d.ts:15

requiresSelection?

readonly optional requiresSelection?: boolean;

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

Methods

run()

run(context): Effect<unknown, E>;

Defined in: apps/website/.api-docs-entry/ui/build/collection-surface/collection-surface.types.d.ts:20

Parameters

Parameter	Type
context	CollectionPipelineContext<TRow>

Returns

Effect<unknown, E>

---

CollectionPipelineContext

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

Type Parameters

Type Parameter
TRow extends object

Properties

collectionName

readonly collectionName: string;

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

selectedRows

readonly selectedRows: readonly TRow[];

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

---

CollectionRecordDeletion

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

Type Parameters

Type Parameter	Default type
TRow extends object	-
E	Error

Properties

description?

readonly optional description?: string;

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

getDisabledReason?

readonly optional getDisabledReason?: (selectedRows) => string | null;

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

Parameters

Parameter	Type
selectedRows	readonly TRow[]

Returns

string | null

label?

readonly optional label?: string;

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

run?

readonly optional run?: (context) => Effect<unknown, E>;

Defined in: apps/website/.api-docs-entry/ui/build/collection-surface/collection-surface.types.d.ts:30

Override the collection delete batch. Absent, the table submits one client.collection[collection].deleteMany(ids), not N single-row loops.

Parameters

Parameter	Type
context	CollectionPipelineContext<TRow>

Returns

Effect<unknown, E>

Type Aliases

CollectionIntegrationState

type CollectionIntegrationState = typeof collectionIntegrationStateSchema.Type;

Defined in: apps/website/.api-docs-entry/ui/build/collection-surface/collection-surface.types.d.ts:33

---

CollectionIntegrationStatus

type CollectionIntegrationStatus = typeof collectionIntegrationStatusSchema.Type;

Defined in: apps/website/.api-docs-entry/ui/build/collection-surface/collection-surface.types.d.ts:41