angular

Interfaces

UseStackOptions

Defined in: packages/angular/src/index.ts:75

Type Parameters

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

Properties

Property	Type	Defined in
`stack?`	`string`	packages/angular/src/index.ts:76
`select?`	(`states`) => `T`	packages/angular/src/index.ts:77
`compare?`	(`a`, `b`) => `boolean`	packages/angular/src/index.ts:78

UseLayerStateOptions

Defined in: packages/angular/src/index.ts:81

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/angular/src/index.ts:87
`stack?`	`string`	packages/angular/src/index.ts:88
`select?`	(`states`) => `U`	packages/angular/src/index.ts:89
`compare?`	(`a`, `b`) => `boolean`	packages/angular/src/index.ts:90

StackHandles

Defined in: packages/angular/src/index.ts:340

Properties

Property	Type	Defined in
`states`	`Signal`<`LayerState`<`unknown`, `void`, `Error`, `unknown`>[]>	packages/angular/src/index.ts:341
`getCall`	(`state`) => `LayerCallContext`<`unknown`, `unknown`>	packages/angular/src/index.ts:342

MutationRun

Defined in: packages/angular/src/index.ts:425

Type Parameters

Type Parameter
`R`

Properties

Property	Type	Description	Defined in
`orEnd`	(`response`) => `Promise`<`void`>	On success, end the layer with `response`; on failure, leave it open and rethrow.	packages/angular/src/index.ts:427

MutationFlow

Defined in: packages/angular/src/index.ts:430

Type Parameters

Type Parameter
`R`

Properties

Property	Type	Description	Defined in
`pending`	`Signal`<`boolean`>	True while a `run(...)` async action is in flight. Mirrors the layer’s `actionStatus: "running"`.	packages/angular/src/index.ts:432
`run`	(`fn`) => `MutationRun`<`R`>	-	packages/angular/src/index.ts:433

ScopedOpen()

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

Open a layer on a pre-bound stack, with DataTag response and error inference.

Call Signature

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

Defined in: packages/angular/src/index.ts:475

Open a layer on a pre-bound stack, with DataTag response and error inference.

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/angular/src/index.ts:483

Open a layer on a pre-bound stack, with DataTag response and error inference.

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/angular/src/index.ts:488

Properties

Property	Type	Description	Defined in
`open`	`ScopedOpen`	-	packages/angular/src/index.ts:489
`dismissAll`	(`response?`) => `void`	-	packages/angular/src/index.ts:490
`states`	`Signal`<`LayerState`<`unknown`, `void`, `Error`, `unknown`>[]>	-	packages/angular/src/index.ts:491
`stackId`	`string`	-	packages/angular/src/index.ts:492
`renderInto`	(`vcr`) => `void`	Imperatively render the child stack into a `ViewContainerRef`. Must run in an injection context (delegates to renderStack).	packages/angular/src/index.ts:497

AppStack

Defined in: packages/angular/src/index.ts:547

Properties

Property	Type	Defined in
`open`	`ScopedOpen`	packages/angular/src/index.ts:548
`dismissAll`	(`response?`) => `void`	packages/angular/src/index.ts:549
`states`	`Signal`<`LayerState`<`unknown`, `void`, `Error`, `unknown`>[]>	packages/angular/src/index.ts:550

StackHook

Defined in: packages/angular/src/index.ts:553

Properties

Property	Type	Description	Defined in
`provideClient`	(`client?`) => `FactoryProvider`	-	packages/angular/src/index.ts:554
`useAppStack`	() => `AppStack`	-	packages/angular/src/index.ts:555
`renderInto`	(`vcr`, `rootProps?`) => `void`	Imperatively render the bound stack into a `ViewContainerRef`. Must run in an injection context (delegates to renderStack).	packages/angular/src/index.ts:560

Type Aliases

WiredLayerHandle

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

Defined in: packages/angular/src/index.ts:93

Type Declaration

Name	Type	Defined in
`state`	`Signal`<`LayerState`<`P`, `R`, `E`, `D`>[]>	packages/angular/src/index.ts:100
`queued`	`Signal`<`LayerState`<`P`, `R`, `E`, `D`>[]>	packages/angular/src/index.ts:101
`top`	`Signal`< \| `LayerState`<`P`, `R`, `E`, `D`> \| `null`>	packages/angular/src/index.ts:102

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/angular/src/index.ts:105

Type Declaration

Name	Type	Defined in
`state`	`Signal`<`LayerState`<`InferValidatorOutput`<`V`>, `R`, `E`, `D`>[]>	packages/angular/src/index.ts:112
`queued`	`Signal`<`LayerState`<`InferValidatorOutput`<`V`>, `R`, `E`, `D`>[]>	packages/angular/src/index.ts:113
`top`	`Signal`< \| `LayerState`<`InferValidatorOutput`<`V`>, `R`, `E`, `D`> \| `null`>	packages/angular/src/index.ts:114

Type Parameters

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

Variables

LAYER_CLIENT

const LAYER_CLIENT: InjectionToken<LayerClient>;

Defined in: packages/angular/src/index.ts:47

Identifies the app LayerClient in Angular dependency injection.

useLayer

const useLayer: {
<V, R, E, D, RP>  (options, client?): WiredValidatedLayerHandle<V, R, E, D, RP>;
<P, R, E, D, RP>  (options, client?): WiredLayerHandle<P, R, E, D, RP>;
} = injectLayer;

Defined in: packages/angular/src/index.ts:326

Alias for injectLayer.

Call Signature

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

Wired handle: createLayer + reactive state/queued/top.

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

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

Wired handle: createLayer + reactive state/queued/top.

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>

injectStack

const injectStack: <T>(opts, client?) => Signal<T> = useStack;

Defined in: packages/angular/src/index.ts:329

Angular-idiomatic alias for useStack.

Bridges a LayerClient stack into an Angular Signal. Must run in an injection context because the subscription uses effect().

Type Parameters

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

Parameters

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

Returns

Signal<T>

injectQueuedStack

const injectQueuedStack: <T>(opts, client?) => Signal<T> = useQueuedStack;

Defined in: packages/angular/src/index.ts:332

Angular-idiomatic alias for useQueuedStack.

Subscribe to a selected slice of a stack’s queued snapshot.

Type Parameters

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

Parameters

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

Returns

Signal<T>

injectLayerState

const injectLayerState: <Key, P, D, U>(opts, client?) => Signal<U> = useLayerState;

Defined in: packages/angular/src/index.ts:335

Angular-idiomatic alias for useLayerState.

Observe all mounted layers matching a key.

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

Signal<U>

injectLayerQueuedState

const injectLayerQueuedState: <Key, P, D, U>(opts, client?) => Signal<U> = useLayerQueuedState;

Defined in: packages/angular/src/index.ts:338

Angular-idiomatic alias for useLayerQueuedState.

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

Signal<U>

Functions

provideLayerClient()

function provideLayerClient(client?): FactoryProvider;

Defined in: packages/angular/src/index.ts:55

Creates a FactoryProvider for the app LayerClient.

Parameters

Parameter	Type	Description
`client?`	`LayerClient`	Client to provide; a new client is created when omitted.

Returns

FactoryProvider

A FactoryProvider for LAYER_CLIENT.

useLayerClient()

function useLayerClient(): LayerClient;

Defined in: packages/angular/src/index.ts:63

Injects the app LayerClient; must run in an Angular injection context.

Returns

LayerClient

useStack()

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

Defined in: packages/angular/src/index.ts:168

Bridges a LayerClient stack into an Angular Signal. Must run in an injection context because the subscription uses effect().

Type Parameters

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

Parameters

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

Returns

Signal<T>

useQueuedStack()

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

Defined in: packages/angular/src/index.ts:186

Subscribe to a selected slice of a stack’s queued snapshot.

Type Parameters

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

Parameters

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

Returns

Signal<T>

useLayerState()

function useLayerState<Key, P, D, U>(opts, client?): Signal<U>;

Defined in: packages/angular/src/index.ts:208

Observe all mounted layers matching a key.

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

Signal<U>

useLayerQueuedState()

function useLayerQueuedState<Key, P, D, U>(opts, client?): Signal<U>;

Defined in: packages/angular/src/index.ts:231

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

Signal<U>

injectLayer()

Call Signature

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

Defined in: packages/angular/src/index.ts:287

Wired handle: createLayer + reactive state/queued/top.

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 injectLayer<P, R, E, D, RP>(options, client?): WiredLayerHandle<P, R, E, D, RP>;

Defined in: packages/angular/src/index.ts:301

Wired handle: createLayer + reactive state/queued/top.

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>

useStackHandles()

function useStackHandles(stackId?, rootProps?): StackHandles;

Defined in: packages/angular/src/index.ts:346

Return the states and call contexts needed to render a stack headlessly.

Parameters

Parameter	Type	Default value
`stackId`	`string`	`"default"`
`rootProps?`	`unknown`	`undefined`

Returns

StackHandles

renderStack()

function renderStack(
   vcr, 
   stackId?, 
   rootProps?): void;

Defined in: packages/angular/src/index.ts:372

Imperatively render every active layer in a stack into a ViewContainerRef. Must run in an injection context (uses inject and effect).

Components are keyed by stable layer id — state changes update inputs via setInput without recreating the ComponentRef.

Parameters

Parameter	Type	Default value
`vcr`	`ViewContainerRef`	`undefined`
`stackId`	`string`	`"default"`
`rootProps?`	`unknown`	`undefined`

Returns

void

useMutationFlow()

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

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

Coordinate a layer’s pending state with an async mutation and end it on success.

Call it in an injection context (e.g. the layer component’s constructor).

Type Parameters

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

Parameters

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

Returns

MutationFlow<R>

Example

// Layer component:
flow = useMutationFlow(this.call);
save() {
  void this.flow.run(() => this.persist()).orEnd(true);
}
// Template: <button [disabled]="flow.pending()" (click)="save()">Confirm</button>

useLayerGroup()

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

Defined in: packages/angular/src/index.ts:506

Create a child stack scoped to the calling layer’s lifetime.

The child stack is disposed and cleared via cancelAll when its parent layer unmounts (LayerCancelledError).

Type Parameters

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

Parameters

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

Returns

LayerGroup

createStackHook()

function createStackHook(config?): StackHook;

Defined in: packages/angular/src/index.ts:564

Create provider, stack access, and imperative outlet hooks bound to one stack.

Parameters

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