Class Lace

Hierarchy (View Summary)

Lace
- Lace

Index

Constructors

Methods

close handle browserLocalStorage compactBrowserLocalStorage compactOpfs memory openBestEffort opfs

Constructors

`Protected`constructor

new Lace(options?: unknown): Lace
Parameters
- Optionaloptions: unknown
Returns Lace

Inherited from Lace.constructor

Methods

close

close(): Promise<void>

Returns Promise<void>

Inherited from Lace.close

handle

handle(): LaceHandle

Returns LaceHandle

Inherited from Lace.handle

`Static`browserLocalStorage

browserLocalStorage(
name?: string,
options?: BrowserLocalStorageOpenOptions,
): Promise<Lace>
Parameters
- Optionalname: string
- Optionaloptions: BrowserLocalStorageOpenOptions
Returns Promise<Lace>

`Static`compactBrowserLocalStorage

compactBrowserLocalStorage(
    name: string,
    policies: Iterable<PolicyInput>,
    options?: BrowserLocalStorageCompactOptions,
): Promise<CompactionReport>
Parameters
- name: string
- policies: Iterable<PolicyInput>
- Optionaloptions: BrowserLocalStorageCompactOptions
Returns Promise<CompactionReport>

`Static`compactOpfs

compactOpfs(
    nameOrHandle: unknown,
    policies: Iterable<PolicyInput>,
    options?: OpfsCompactOptions,
): Promise<CompactionReport>
Removes records no policy selects from a root with no open Lace, resuming an interrupted compaction.
Parameters
- nameOrHandle: unknown
- policies: Iterable<PolicyInput>
- Optionaloptions: OpfsCompactOptions
Returns Promise<CompactionReport>

`Static`memory

memory(options?: LaceOpenOptions): Promise<Lace>
Parameters
- Optionaloptions: LaceOpenOptions
Returns Promise<Lace>

Inherited from Lace.memory

`Static`openBestEffort

openBestEffort(
storeName?: string,
options?: BrowserBestEffortOpenOptions,
): Promise<Lace>
Parameters
- OptionalstoreName: string
- Optionaloptions: BrowserBestEffortOpenOptions
Returns Promise<Lace>
openBestEffort(options?: BrowserBestEffortOpenOptions): Promise<Lace>
Parameters
- Optionaloptions: BrowserBestEffortOpenOptions
Returns Promise<Lace>

`Static`opfs

opfs(nameOrHandle?: unknown, options?: OpfsOpenOptions): Promise<Lace>
Parameters
- OptionalnameOrHandle: unknown
- Optionaloptions: OpfsOpenOptions
Returns Promise<Lace>