Class Backend

constructor

• new Backend(source, o?): Backend

• Parameters

  • source: string

    URL string describing the data location

  • o: any = {}

    Options

  Returns Backend

data

options

permissions

rawData

ref

source

Static _all

Static authProvider

Static capabilities

Static defaultFormat

Static hooks

Static all

• get all(): any[]

• Returns any[]

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

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

Static title

• get title(): string

• Returns string

_getRef

• _getRef(ref): any

• Parameters

  • ref: any

  Returns any

equals

• equals(backend): boolean

• Parameters

  • backend: any

  Returns boolean

get

• get(ref?): string

• 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.

  Parameters

  • ref: any = ...

    reference to data to fetch, if different from that provided in the constructor

  Returns string

  • Data from the backend as a string, null if not found

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

parse

• parse(data, __namedParameters?): Promise<any>

• Parameters

  • data: any

  • __namedParameters: {
        ref: any;
    } = {}

    • ref: any

  Returns Promise<any>

remove

• remove(ref?): Promise<any>

• Parameters

  • ref: any = ...

  Returns Promise<any>

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

stringify

• stringify(data, __namedParameters?): Promise<any>

• Parameters

  • data: any

  • __namedParameters: {
        ref: any;
    } = {}

    • ref: any

  Returns Promise<any>

toString

• toString(): string

• Returns string

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

updatePermissions

• updatePermissions(o): void

• Parameters

  • o: any

  Returns void

Static find

• find(url, o): any

• Parameters

  • url: any

  • o: any

  Returns any

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

Static load

• load(url, o): Promise<any>

• Parameters

  • url: any

  • o: any

  Returns Promise<any>

Static parseURL

• parseURL(source): any

• Parameters

  • source: any

  Returns any

Static phrase

• phrase(id, ...args): string

• Parameters

  • id: any

  • Rest ...args: any[]

  Returns string

Static register

• register(Class): any

• Parameters

  • Class: any

  Returns any

Static test

• test(source): boolean

• Parameters

  • source: any

  Returns boolean