alpine

Property	Type	Defined in
`stack?`	`string`	packages/alpine/src/index.ts:105
`select?`	(`states`) => `T`	packages/alpine/src/index.ts:106
`compare?`	(`a`, `b`) => `boolean`	packages/alpine/src/index.ts:107
`client?`	`LayerClient`	packages/alpine/src/index.ts:108

UseLayerStateOptions

Defined in: packages/alpine/src/index.ts:111

Type Parameters

Type Parameter	Default type
`Key` extends `LayerKey`	-
`P`	`unknown`
`D`	`unknown`
`U`	`LayerState`<`P`, `ResponseOf`<`Key`>, `ErrorOf`<`Key`>, `D`>[]

Properties

Property	Type	Defined in
`key`	`Key`	packages/alpine/src/index.ts:117
`stack?`	`string`	packages/alpine/src/index.ts:118
`select?`	(`states`) => `U`	packages/alpine/src/index.ts:119
`compare?`	(`a`, `b`) => `boolean`	packages/alpine/src/index.ts:120

AlpineStack

Defined in: packages/alpine/src/index.ts:124

Reactive stack accessor (.current + callFor).

Type Parameters

Type Parameter	Default type
`RootProps`	`unknown`
`T`	`LayerState`[]

Properties

Property	Modifier	Type	Defined in
`current`	`readonly`	`T`	packages/alpine/src/index.ts:125

Methods

callFor()

callFor(state, rootProps?): 
  | LayerCallContext<unknown, unknown, RootProps>
  | null;

Defined in: packages/alpine/src/index.ts:126

Parameters

Parameter	Type
`state`	`LayerState`
`rootProps?`	`RootProps`

Returns

| LayerCallContext<unknown, unknown, RootProps> | null

destroy()

destroy(): void;

Defined in: packages/alpine/src/index.ts:130

Returns

void

MutationRun

Defined in: packages/alpine/src/index.ts:414

Type Parameters

Type Parameter
`R`

Properties

Property	Type	Description	Defined in
`orEnd`	(`response`) => `Promise`<`void`>	End the layer with `response` after the action succeeds.	packages/alpine/src/index.ts:416

MutationFlow

Defined in: packages/alpine/src/index.ts:419

Type Parameters

Type Parameter
`R`

Properties

Property	Modifier	Type	Description	Defined in
`pending`	`readonly`	`boolean`	True while the async action passed to `run` is in flight.	packages/alpine/src/index.ts:421
`run`	`public`	(`fn`) => `MutationRun`<`R`>	-	packages/alpine/src/index.ts:422

ScopedOpen()

Defined in: packages/alpine/src/index.ts:451

Open on a pre-bound stack; DataTag keys infer response/error types.

Call Signature

ScopedOpen<P, R, E, D, RootProps>(options): Promise<R>;

Defined in: packages/alpine/src/index.ts:452

Open on a pre-bound stack; DataTag keys infer response/error types.

Type Parameters

Type Parameter	Default type
`P`	-
`R`	-
`E`	`Error`
`D`	`unknown`
`RootProps`	`unknown`

Parameters

Parameter	Type
`options`	`OmitKeyof`<`OpenLayerOptions`<`P`, `R`, `E`, `D`, `RootProps`> & `object`, `"stack"` \| `"validate"`>

Returns

Promise<R>

Call Signature

ScopedOpen<P, R, E, D, RootProps>(options): Promise<R>;

Defined in: packages/alpine/src/index.ts:460

Open on a pre-bound stack; DataTag keys infer response/error types.

Type Parameters

Type Parameter	Default type
`P`	-
`R`	`void`
`E`	`Error`
`D`	`unknown`
`RootProps`	`unknown`

Parameters

Parameter	Type
`options`	`OmitKeyof`<`OpenLayerOptions`<`P`, `R`, `E`, `D`, `RootProps`>, `"stack"`>

Returns

Promise<R>

LayerGroup

Defined in: packages/alpine/src/index.ts:465

Type Parameters

Type Parameter	Default type
`RootProps`	`unknown`

Properties

Property	Type	Defined in
`open`	`ScopedOpen`	packages/alpine/src/index.ts:466
`dismissAll`	(`response?`) => `void`	packages/alpine/src/index.ts:467
`states`	`AlpineStack`<`RootProps`>	packages/alpine/src/index.ts:468
`stackId`	`string`	packages/alpine/src/index.ts:469

Methods

dispose()

dispose(): void;

Defined in: packages/alpine/src/index.ts:474

Tear down the group subscription and cancelAll child layers (LayerCancelledError, reason groupDispose).

Returns

void

AppStack

Defined in: packages/alpine/src/index.ts:514

Properties

Property	Type	Defined in
`open`	`ScopedOpen`	packages/alpine/src/index.ts:515
`dismissAll`	(`response?`) => `void`	packages/alpine/src/index.ts:516
`states`	`AlpineStack`	packages/alpine/src/index.ts:517

StackHook

Defined in: packages/alpine/src/index.ts:520

Properties

Property	Type	Defined in
`setClient`	(`client?`) => `LayerClient`	packages/alpine/src/index.ts:521
`useAppStack`	() => `AppStack`	packages/alpine/src/index.ts:522

Type Aliases

WiredLayerHandle

type WiredLayerHandle<P, R, E, D, RP> = LayerHandle<P, R, E, D, RP> & object;

Defined in: packages/alpine/src/index.ts:296

Type Declaration

Name	Type	Defined in
`state`	`LayerState`<`P`, `R`, `E`, `D`>[]	packages/alpine/src/index.ts:303
`queued`	`LayerState`<`P`, `R`, `E`, `D`>[]	packages/alpine/src/index.ts:304
`top`	\| `LayerState`<`P`, `R`, `E`, `D`> \| `null`	packages/alpine/src/index.ts:305

Type Parameters

Type Parameter	Default type
`P`	-
`R`	-
`E`	`DefaultLayerError`
`D`	`unknown`
`RP`	`unknown`

WiredValidatedLayerHandle

type WiredValidatedLayerHandle<V, R, E, D, RP> = ValidatedLayerHandle<V, R, E, D, RP> & object;

Defined in: packages/alpine/src/index.ts:308

Type Declaration

Name	Type	Defined in
`state`	`LayerState`<`InferValidatorOutput`<`V`>, `R`, `E`, `D`>[]	packages/alpine/src/index.ts:315
`queued`	`LayerState`<`InferValidatorOutput`<`V`>, `R`, `E`, `D`>[]	packages/alpine/src/index.ts:316
`top`	\| `LayerState`<`InferValidatorOutput`<`V`>, `R`, `E`, `D`> \| `null`	packages/alpine/src/index.ts:317

Type Parameters

Type Parameter	Default type
`V` extends `Validator`<`unknown`>	-
`R`	-
`E`	`DefaultLayerError`
`D`	`unknown`
`RP`	`unknown`

Functions

useStack()

function useStack<RootProps, T>(opts?, client?): AlpineStack<RootProps, T>;

Defined in: packages/alpine/src/index.ts:202

Subscribe to a stack snapshot (.current + callFor).

Type Parameters

Type Parameter	Default type
`RootProps`	`unknown`
`T`	`LayerState`<`unknown`, `void`, `Error`, `unknown`>[]

Parameters

Parameter	Type
`opts`	`UseStackOptions`<`T`>
`client?`	`LayerClient`

Returns

AlpineStack<RootProps, T>

Default

stack is "default"; select is identity; compare is Object.is.

useQueuedStack()

function useQueuedStack<RootProps, T>(opts?, client?): AlpineStack<RootProps, T>;

Defined in: packages/alpine/src/index.ts:220

Subscribe to a stack’s queued snapshot (.current + callFor).

Type Parameters

Type Parameter	Default type
`RootProps`	`unknown`
`T`	`LayerState`<`unknown`, `void`, `Error`, `unknown`>[]

Parameters

Parameter	Type
`opts`	`UseStackOptions`<`T`>
`client?`	`LayerClient`

Returns

AlpineStack<RootProps, T>

Default

stack is "default"; select is identity; compare is Object.is.

createLayerState()

function createLayerState<Key, P, D, U>(opts, client?): AlpineStack<unknown, U>;

Defined in: packages/alpine/src/index.ts:243

Observe all mounted layers matching a key (.current + callFor).

A DataTag key infers its response and error types.

Type Parameters

Type Parameter	Default type
`Key` extends `LayerKey`	-
`P`	`unknown`
`D`	`unknown`
`U`	`LayerState`<`P`, `ResponseOf`<`Key`>, `ErrorOf`<`Key`>, `D`>[]

Parameters

Parameter	Type
`opts`	`UseLayerStateOptions`<`Key`, `P`, `D`, `U`>
`client?`	`LayerClient`

Returns

AlpineStack<unknown, U>

createLayerQueuedState()

function createLayerQueuedState<Key, P, D, U>(opts, client?): AlpineStack<unknown, U>;

Defined in: packages/alpine/src/index.ts:270

Observe all queued layers matching a key.

Type Parameters

Type Parameter	Default type
`Key` extends `LayerKey`	-
`P`	`unknown`
`D`	`unknown`
`U`	`LayerState`<`P`, `ResponseOf`<`Key`>, `ErrorOf`<`Key`>, `D`>[]

Parameters

Parameter	Type
`opts`	`UseLayerStateOptions`<`Key`, `P`, `D`, `U`>
`client?`	`LayerClient`

Returns

AlpineStack<unknown, U>

createLayer()

Call Signature

function createLayer<V, R, E, D, RP>(options, client?): WiredValidatedLayerHandle<V, R, E, D, RP>;

Defined in: packages/alpine/src/index.ts:376

Drive a layer — wired handle with reactive state / queued / top. Prefer $layers.open from markup when a typed handle is not needed.

Type Parameters

Type Parameter	Default type
`V` extends `Validator`<`unknown`>	-
`R`	-
`E`	`Error`
`D`	`unknown`
`RP`	`unknown`

Parameters

Parameter	Type
`options`	`LayerOptions`<`InferValidatorOutput`<`V`>, `R`, `E`, `D`, `RP`> & `object`
`client?`	`LayerClient`

Returns

WiredValidatedLayerHandle<V, R, E, D, RP>

Call Signature

function createLayer<P, R, E, D, RP>(options, client?): WiredLayerHandle<P, R, E, D, RP>;

Defined in: packages/alpine/src/index.ts:390

Drive a layer — wired handle with reactive state / queued / top. Prefer $layers.open from markup when a typed handle is not needed.

Type Parameters

Type Parameter	Default type
`P`	-
`R`	-
`E`	`Error`
`D`	`unknown`
`RP`	`unknown`

Parameters

Parameter	Type
`options`	`LayerOptions`<`P`, `R`, `E`, `D`, `RP`> & `object`
`client?`	`LayerClient`

Returns

WiredLayerHandle<P, R, E, D, RP>

useMutationFlow()

function useMutationFlow<P, R, RootProps>(call): MutationFlow<R>;

Defined in: packages/alpine/src/index.ts:426

Coordinate call.setRunning with an async action; orEnd ends on success.

Type Parameters

Type Parameter	Default type
`P`	-
`R`	-
`RootProps`	`unknown`

Parameters

Parameter	Type
`call`	`LayerCallContext`<`P`, `R`, `RootProps`>

Returns

MutationFlow<R>

useLayerGroup()

function useLayerGroup<P, R, RootProps>(
   call, 
   options?, 
client?): LayerGroup<RootProps>;

Defined in: packages/alpine/src/index.ts:482

Nested child stack for a parent layer call. Render with a nested x-layer-outlet bound to LayerGroup.stackId. Parent cleanup cancelAlls the child stack (LayerCancelledError).

Type Parameters

Type Parameter	Default type
`P`	-
`R`	-
`RootProps`	`unknown`

Parameters

Parameter	Type
`call`	`LayerCallContext`<`P`, `R`, `RootProps`>
`options?`	`LayerGroupOptions`
`client?`	`LayerClient`

Returns

LayerGroup<RootProps>

createStackHook()

function createStackHook(config?): StackHook;

Defined in: packages/alpine/src/index.ts:529

Bind a named stack + client.

Parameters

Parameter	Type
`config`	{ `client?`: `LayerClient`; `stack?`: `string`; }
`config.client?`	`LayerClient`
`config.stack?`	`string`

Returns

StackHook

{ setClient, useAppStack } — open/dismissAll/states scoped to stack.

layers()

function layers(Alpine): void;

Defined in: packages/alpine/src/index.ts:758

Alpine plugin — registers $layers, $layer, x-layer-outlet, and Alpine.data('layerStack').

Parameters

Parameter	Type
`Alpine`	`AlpineLike`

Returns

void

getLayerClient()

function getLayerClient(): LayerClient;

Defined in: packages/alpine/src/layer-client.ts:20

Lazy LayerClient singleton. Created on first access when setLayerClient has not run yet.

Returns

LayerClient

setLayerClient()

function setLayerClient(client?): LayerClient;

Defined in: packages/alpine/src/layer-client.ts:30

Pin the shared client before first use. Throws when called after the client has been resolved lazily or by any adapter API.

Parameters

Parameter	Type
`client?`	`LayerClient`