Class Backend

Base class for all backends.

Hierarchy (view full)

EventTarget
- Backend

Index

Constructors

constructor

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

Properties

data

data: any

options

options: any

permissions

permissions: any

rawData

rawData: string

ref

ref: any

source

source: string

`Static` _all

_all: any[] = []

`Static` api

api: {} = {}

Type declaration

`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: {} = {}

Type declaration

`Static` defaultFormat

defaultFormat: string = "JSON"

`Static` hooks

hooks: Hooks = hooks

`Static` phrases

phrases: {
    created_file: ((name?) => string);
    deleted_file: ((name?) => string);
    no_upload_permission: string;
    no_write_permission: string;
    something_went_wrong_while_connecting: ((name) => string);
    updated_file: ((name?) => string);
    uploaded_file: ((name?) => string);
} = ...

Type declaration

created_file: ((name?) => string)
- - (name?): string
  - Parameters
    - name: string = "file"
    Returns string
deleted_file: ((name?) => string)
- - (name?): string
  - Parameters
    - name: string = "file"
    Returns string
no_upload_permission: string
no_write_permission: string
something_went_wrong_while_connecting: ((name) => string)
- - (name): string
  - Parameters
    - name: any
    Returns string
updated_file: ((name?) => string)
- - (name?): string
  - Parameters
    - name: string = "file"
    Returns string
uploaded_file: ((name?) => string)
- - (name?): string
  - Parameters
    - name: string = "file"
    Returns string

Accessors

`Static` all

get all(): any[]
Returns any[]
- Defined in src/backend.js:439

`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
- Defined in src/backend.js:498

`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
- Defined in src/backend.js:354

`Static` title

get title(): string
Returns string
- Defined in src/backend.js:44

Methods

`Private` #getFormat

#getFormat(ref): any
Parameters
- ref: any
Returns any
- Defined in src/backend.js:102

_getRef

_getRef(ref): any
Parameters
- ref: any
Returns any
- Defined in src/backend.js:236

equals

equals(backend): boolean
Parameters
- backend: any
Returns boolean
- Defined in src/backend.js:341

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
- Defined in src/backend.js:226

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
- Defined in src/backend.js:259

parse

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

put

put(data, options): Promise<void>
Parameters
- data: any
- options: any
Returns Promise<void>
- Defined in src/backend.js:290

remove

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

request

request(call, data?, method?, req?): Promise<any>
Helper for making HTTP requests with JSON-based APIs.
Parameters
- call: string
  API endpoint
- Optional data: any
  Data to send with the request
- Optional method: string = "GET"
  HTTP method
- Optional req: {
  headers: any;
  responseType: string;
  }
  Extra request options
  - headers: any
    Extra headers
  - responseType: string
    Response type
Returns Promise<any>
- JSON response
- Defined in src/backend.js:161

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
- Defined in src/backend.js:311

stringify

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

toString

toString(): string
Returns string
- Defined in src/backend.js:337

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
- Defined in src/backend.js:53

updatePermissions

updatePermissions(o): void
Parameters
- o: any
Returns void
- Defined in src/backend.js:132

upload

upload(file, options): Promise<void>
Parameters
- file: any
- options: any
Returns Promise<void>
- Defined in src/backend.js:297

`Static` find

find(url, o): any
Parameters
- url: any
- o: any
Returns any
- Defined in src/backend.js:447

`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
- Defined in src/backend.js:393

`Static` load

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

`Static` parseURL

parseURL(source): any
Parameters
- source: any
Returns any
- Defined in src/backend.js:372

`Static` phrase

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

`Static` register

register(Class): any
Parameters
- Class: any
Returns any
- Defined in src/backend.js:463

`Static` test

test(source): boolean
Parameters
- source: any
Returns boolean
- Defined in src/backend.js:345

Class Backend

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

source: string

o: any = {}

Returns Backend

Properties

data

options

permissions

rawData

ref

source

Static _all

Static api

Type declaration

Static authProvider

Static capabilities

Type declaration

Static defaultFormat

Static hooks

Static phrases

Type declaration

created_file: ((name?) => string)

Parameters

name: string = "file"

Returns string

deleted_file: ((name?) => string)

Parameters

name: string = "file"

Returns string

no_upload_permission: string

no_write_permission: string

something_went_wrong_while_connecting: ((name) => string)

Parameters

name: any

Returns string

updated_file: ((name?) => string)

Parameters

name: string = "file"

Returns string

uploaded_file: ((name?) => string)

Parameters

name: string = "file"

Returns 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

Parameters

ref: any = ...

Returns string

load

`Static` _all

`Static` api

`Static` authProvider

`Static` capabilities

`Static` defaultFormat

`Static` hooks

`Static` phrases

`Static` all

`Static` authProviderServices

`Static` host

`Static` title

`Private` #getFormat

`Rest` ...args: any[]

__namedParameters: {
ref: any;
} = {}

`Optional` data: any

`Optional` method: string = "GET"

`Optional` req: {
headers: any;
responseType: string;
}

`Optional` o: any = {}

__namedParameters: {
ref: any;
} = {}

`Static` find

`Static` from

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

`Static` load