Class default

Adapter that, given a URL, looks up metadata that can identify a review subject, such as a book's title or a restaurant name.

Hierarchy (View Summary)

default
- default

Index

Constructors

Properties

sourceID? supportedPattern? updateCallback

Methods

ask getSourceID lookup

Constructors

constructor

new default(updateCallback?: Function): default
Parameters
- OptionalupdateCallback: Function
Returns default
Overrides default.constructor
- Defined in frontend/adapters/openstreetmap-lookup-adapter.ts:19

Properties

`Optional`sourceID

sourceID?: string

Canonical identifier for this source. Lower-case string, no whitespace.

`Optional`supportedPattern

supportedPattern?: RegExp

RegExp for URLs this adapter can handle.

updateCallback

updateCallback: Function | UpdateCallback

Callback to run after a successful lookup

Methods

ask

ask(url: string): boolean
Does this adapter support the given URL? By default, performs a simple regex check.
Parameters
- url: string
  the URL to test
Returns boolean
true if supported
Inherited from default.ask
- Defined in frontend/adapters/abstract-lookup-adapter.ts:46

getSourceID

getSourceID(): string
Return the canonical source identifier for this adapter

Returns string
the source ID
Inherited from default.getSourceID
- Defined in frontend/adapters/abstract-lookup-adapter.ts:67

`Abstract`lookup

lookup(url: string): Promise<LookupResult>
Perform a lookup for a given URL.
Parameters
- url: string
Returns Promise<LookupResult>
promise that resolves with a LookupResult on success, and rejects with an error on failure
Overrides default.lookup
- Defined in frontend/adapters/openstreetmap-lookup-adapter.ts:25