Skip to main content Link Search Menu Expand Document (external link)

Layer overview

Added in v1.0.0


Table of contents


utils

Commit (type alias)

Signature

export type Commit = (to: Destination, event: BeforeNavigationEvent) => Effect.Effect<void, NavigationError>

Added in v1.0.0

InitialMemoryOptions (interface)

Signature

export interface InitialMemoryOptions {
  readonly url: string | URL
  readonly origin?: string | undefined
  readonly base?: string | undefined
  readonly maxEntries?: number | undefined
  readonly state?: unknown
  readonly commit?: Commit
}

Added in v1.0.0

MemoryOptions (interface)

Signature

export interface MemoryOptions {
  readonly entries: ReadonlyArray<Destination>
  readonly origin?: string | undefined
  readonly base?: string | undefined
  readonly currentIndex?: number | undefined
  readonly maxEntries?: number | undefined
  readonly commit?: Commit
}

Added in v1.0.0

fromWindow

Signature

export declare const fromWindow: Layer.Layer<Navigation, never, Window>

Added in v1.0.0

initialMemory

Signature

export declare const initialMemory: (options: InitialMemoryOptions) => Layer.Layer<Navigation>

Added in v1.0.0

memory

Signature

export declare const memory: (options: MemoryOptions) => Layer.Layer<Navigation>

Added in v1.0.0