Class Local

Store data in the browser's localStorage.

Hierarchy (view full)

Backend
- Local

Index

Constructors

constructor

new Local(source, o?): Local
Parameters
- source: string
  URL string describing the data location
- o: any = {}
  Options
Returns Local
Inherited from Backend.constructor
- Defined in src/backend.js:20

Properties

data

data: any

options

options: any

permissions

permissions: any

rawData

rawData: string

ref

ref: any

source

source: string

`Static` _all

_all: any[] = []

`Static` authProvider

authProvider: string = "https://auth.madata.dev"

Auth Provider to use. This is only relevant for OAuthBackend, but specifying here as Backend is the only class users import.

`Static` capabilities

capabilities: {
put: boolean;
} = ...

Type declaration

put: boolean

`Static` defaultFormat

defaultFormat: string = "JSON"

`Static` defaultPermissions

defaultPermissions: {
    edit: boolean;
    read: boolean;
    save: boolean;
} = ...

Type declaration

edit: boolean
read: boolean
save: boolean

`Static` hooks

hooks: Hooks = hooks

`Static` urls

urls: {
pathname: string;
protocol: string;
}[] = ...

Type declaration

pathname: string
protocol: string

Accessors

`Static` all

get all(): any[]
Returns any[]
Inherited from Backend.all
- Defined in src/backend.js:353

`Static` authProviderServices

get authProviderServices(): Promise<any>
services.json from the auth provider will be cached here. You could also set this manually to avoid the network request.

Returns Promise<any>
Member
Inherited from Backend.authProviderServices
- Defined in src/backend.js:415

`Static` host

get host(): any
Return the hostname of the first URL pattern in the urls array, if not variable. This is used to facilitate relative URLs when constructing Backends directly. Subclasses with variable hostnames can override this.

Returns any
Inherited from Backend.host
- Defined in src/backend.js:266

`Static` title

get title(): string
Returns string
Inherited from Backend.title
- Defined in src/backend.js:31

Methods

`Private` #getFormat

#getFormat(ref): any
Parameters
- ref: any
Returns any
Inherited from Backend.#getFormat
- Defined in src/backend.js:89

_getRef

_getRef(ref): any
Parameters
- ref: any
Returns any
Inherited from Backend._getRef
- Defined in src/backend.js:162

equals

equals(backend): boolean
Parameters
- backend: any
Returns boolean
Inherited from Backend.equals
- Defined in src/backend.js:253

get

get(): Promise<any>
Low-level method to fetch data from the backend. Subclasses should override this method. Clients should not call this method directly, but use load() instead.

Returns Promise<any>
- Data from the backend as a string, null if not found
Overrides Backend.get
- Defined in backends/basic/local.js:20

load

load(url, ...args): any
Higher-level method for reading data from the backend. Subclasses should usually NOT override this method.
Parameters
- url: string
  URL to fetch, if different from that provided in the constructor
- Rest ...args: any[]
Returns any
- Data from the backend as a JSON object, null if not found
Inherited from Backend.load
- Defined in src/backend.js:185

parse

parse(data, __namedParameters?): Promise<any>
Parameters
- data: any
- __namedParameters: {
  ref: any;
  } = {}
  - ref: any
Returns Promise<any>
Inherited from Backend.parse
- Defined in src/backend.js:61

put

put(data): Promise<{
type: string;
}>
Parameters
- data: any
Returns Promise<{
type: string;
}>
- Defined in backends/basic/local.js:28

remove

remove(ref?): Promise<any>
Parameters
- ref: any = ...
Returns Promise<any>
Inherited from Backend.remove
- Defined in src/backend.js:237

store

store(data, o?): any
Higher-level method for writing data to the backend. Subclasses should usually NOT override this method.
Parameters
- data: any
  Data to write to the backend
- Optional o: any = {}
  Options object
Returns any
- If successful, info about the stored data
Inherited from Backend.store
- Defined in src/backend.js:223

stringify

stringify(data, __namedParameters?): Promise<any>
Parameters
- data: any
- __namedParameters: {
  ref: any;
  } = {}
  - ref: any
Returns Promise<any>
Inherited from Backend.stringify
- Defined in src/backend.js:75

toString

toString(): string
Returns string
Inherited from Backend.toString
- Defined in src/backend.js:249

update

update(source, o?): void
Update an existing backend instance with new parameters
Parameters
- source: string
  Same as constructor
- o: any = {}
  Same as constructor
Returns void
Inherited from Backend.update
- Defined in src/backend.js:40

updatePermissions

updatePermissions(o): void
Parameters
- o: any
Returns void
Inherited from Backend.updatePermissions
- Defined in src/backend.js:119

`Static` find

find(url, o): any
Parameters
- url: any
- o: any
Returns any
Inherited from Backend.find
- Defined in src/backend.js:361

`Static` from

from(url, o?): any
Return the appropriate backend(s) for this url
Parameters
- url: string
  URL describing the storage location
- Optional o: {
  existing: Backend | Backend[];
  } = {}
  Options object to be passed to the backend
  - existing: Backend | Backend[]
    Existing backend object(s) to re-use if possible
Returns any
Inherited from Backend.from
- Defined in src/backend.js:305

`Static` load

load(url, o): Promise<any>
Parameters
- url: any
- o: any
Returns Promise<any>
Inherited from Backend.load
- Defined in src/backend.js:339

`Static` parseURL

parseURL(source): any
Parameters
- source: any
Returns any
Inherited from Backend.parseURL
- Defined in src/backend.js:284

`Static` phrase

phrase(id, ...args): string
Parameters
- id: any
- Rest ...args: any[]
Returns string
Inherited from Backend.phrase
- Defined in src/backend.js:400

`Static` register

register(Class): any
Parameters
- Class: any
Returns any
Inherited from Backend.register
- Defined in src/backend.js:377

`Static` test

test(source): boolean
Parameters
- source: any
Returns boolean
Inherited from Backend.test
- Defined in src/backend.js:257

Class Local

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

source: string

o: any = {}

Returns Local

Properties

data

options

permissions

rawData

ref

source

Static _all

Static authProvider

Static capabilities

Type declaration

put: boolean

Static defaultFormat

Static defaultPermissions

Type declaration

edit: boolean

read: boolean

save: boolean

Static hooks

Static urls

Type declaration

pathname: string

protocol: string

Accessors

Static all

Returns any[]

Static authProviderServices

Returns Promise<any>

Member

Static host

Returns any

Static title

Returns string

Methods

Private #getFormat

Parameters

ref: any

Returns any

_getRef

Parameters

ref: any

Returns any

equals

Parameters

backend: any

Returns boolean

get

Returns Promise<any>

load

Parameters

url: string

Rest ...args: any[]

Returns any

parse

Parameters

data: any

__namedParameters: { ref: any; } = {}

ref: any

Returns Promise<any>

put

Parameters

data: any

Returns Promise<{ type: string; }>

remove

Parameters

ref: any = ...

Returns Promise<any>

`Static` _all

`Static` authProvider

`Static` capabilities

`Static` defaultFormat

`Static` defaultPermissions

`Static` hooks

`Static` urls

`Static` all

`Static` authProviderServices

`Static` host

`Static` title

`Private` #getFormat

`Rest` ...args: any[]

__namedParameters: {
ref: any;
} = {}

Returns Promise<{
type: string;
}>

`Optional` o: any = {}

__namedParameters: {
ref: any;
} = {}

`Static` find

`Static` from

`Optional` o: {
existing: Backend | Backend[];
} = {}

`Static` load

`Static` parseURL

`Static` phrase

`Rest` ...args: any[]

`Static` register

`Static` test