Skip to main content

Type Aliases

DatasetLayout

Ƭ DatasetLayout: Object

Type declaration


DatasetPartition

Ƭ DatasetPartition: { transform: "identity" ; field: string } | { transform: "year" ; field: string } | { transform: "month" ; field: string } | { transform: "day" ; field: string } | { transform: "hour" ; field: string } | { transform: "bucket" ; field: string ; count: number } | { transform: "truncate" ; field: string ; width: number } Not exported: an exported type refers to it.

DatasetSort

Ƭ DatasetSort: Object Not exported: an exported type refers to it.

Type declaration


NullPlacement

Ƭ NullPlacement: "first" | "last" Not exported: an exported type refers to it.

BrowserBinding

Ƭ BrowserBinding<R>: R extends BrowserResourceReference<any> ? 0 extends 1 & R["_browser"] ? false : true : false Not exported: an exported type refers to it.

Type parameters


BrowserExecution

Ƭ BrowserExecution: { browser: BrowserResourceReference<any, "enforced"> ; confinement?: "enforced" } | { browser: BrowserResourceReference<any, "unenforced"> ; confinement: "unenforced" } An enforced capability is the default. A capability whose provider cannot block traffic that bypasses the native broker requires an explicit confinement: "unenforced", so weaker guarantees are never selected silently.

DeclaredConnection

Ƭ DeclaredConnection<Connector, Setup>: Object A deployment-owned connection declaration. Its resource identifies the native connection contract; credentials remain private inventory references. Native preflight resolves defaults and activation installs its exact identity.

Type parameters

Type declaration


ConnectionSetup

Ƭ ConnectionSetup<R>: Pick<R["_setup"], Extract<R["_connectionKeys"], keyof R["_setup"]>> Not exported: an exported type refers to it.

Type parameters


ConnectionInput

Ƭ ConnectionInput<R>: { setup: ConnectionSetup<R> ; component?: string } & R["_credential"] extends "none" ? { credential?: never } : { credential: CredentialReference<R["_credential"]> }

Type parameters


BindingInput

Ƭ BindingInput<R>: { acquisition?: BrowserBinding<R> extends true ? never : { every: SyncEvery } ; component?: BrowserBinding<R> extends true ? never : string ; execution?: BrowserBinding<R> extends true ? never : BrowserExecution } & BrowserBinding<R> extends true ? { name?: never } : { name?: string } & { setup: R["_setup"] ; connection?: never } & R["_credential"] extends "none" ? { credential?: never } : { credential: CredentialReference<R["_credential"]> } | { connection: BrowserBinding<R> extends true ? never : ConnectionReference<R["_connector"], ConnectionSetup<R>> | DeclaredConnection<R["_connector"], ConnectionSetup<R>> ; setup: Omit<R["_setup"], R["_connectionKeys"]> ; credential?: never }

Type parameters


BindingAddress

Ƭ BindingAddress: Object

Type declaration


ResourceBinding

Ƭ ResourceBinding: Object One desired binding. It contains references and non-secret setup only.

Type declaration


DatasetStorage

Ƭ DatasetStorage: Object Physical placement of one logical dataset. Catalog credentials belong to the registered catalog, independently of the source connection.

Type declaration


DatasetBindingInput

Ƭ DatasetBindingInput: Object

Type declaration


DatasetBinding

Ƭ DatasetBinding: Object

Type declaration


DeploymentBinding

Ƭ DeploymentBinding: ResourceBinding | DatasetBinding

Functions

connect

▸ connect<R>(resource, input): DeclaredConnection<R["_connector"], ConnectionSetup<R>> Declare one connection that any compatible resource bindings may share.

Type parameters

Parameters

Returns

DeclaredConnection<R["_connector"], ConnectionSetup<R>>

bind

▸ bind<R>(resource, input): ResourceBinding Bind a resource declaration to deployment-owned coordinates and custody.

Type parameters

Parameters

Returns

ResourceBinding ▸ bind(resource, input): DatasetBinding

Parameters

Returns

DatasetBinding

publishTogether

▸ publishTogether(group, bindings): readonly ResourceBinding[] Join independently acquired inputs in one local visibility commit. Each member retains its own provider cut; this declares no shared snapshot.

Parameters

Returns

readonly ResourceBinding[]

defineBindings

▸ defineBindings(bindings): readonly DeploymentBinding[] Evaluate this deployment-only module after application code generation. Removing an entry does not erase retained source data or private credentials.

Parameters

Returns

readonly DeploymentBinding[]