NgDocStoreService

Reads and writes NgDoc settings (for example the theme) in the browser's local storage.

Decorators: @Service

DeclarationTypeScript

@Service()
export class NgDocStoreService { … }

Members

Properties

localStorage: Storage

protectedreadonly

—

Methods

(…): string | T | null

—

Signature

get(key: string, deserialize?: ((v: string | null) => T) | undefined): string | T | null;

Parameters

Name	Type	Description
key	`string`
deserialize	`((v: string \| null) => T) \| undefined`

Returns

string | T | null

Overloads

Overload #1

Returns the stored string, or null when the key is not set.

Presentation

get(key: string): string | null;

Parameters

Name	Type	Description
key	`string`	Storage key.

Returns

string | null

Overload #2

Returns the stored value, deserialized.

Presentation

get(key: string, deserialize: (v: string | null) => T): T;

Parameters

Name	Type	Description
key	`string`	Storage key.
deserialize	`(v: string \| null) => T`	Converts the stored string (or `null`) to the value.

Returns

T

(…): void

—

Signature

set(key: string, data: T, serialize: (v: T) => string = DEFAULT_SERIALIZE): void;

Parameters

Name	Type	Description
key	`string`
data	`T`
serialize	`(v: T) => string`

Returns

void

Overloads

Overload #1

Stores a string value.

Presentation

set(key: string, data: string): void;

Parameters

Name	Type	Description
key	`string`	Storage key.
data	`string`	The value to store.

Returns

void

Overload #2

Stores a value after serializing it.

Presentation

set(key: string, data: T, serialize: (v: T) => string): void;

Parameters

Name	Type	Description
key	`string`	Storage key.
data	`T`	The value to store.
serialize	`(v: T) => string`	Converts the value to a string.

Returns

void

Symbol

Kind: Class
Decorators: @Service
Scope: @ng-doc/app

Edit this page