Class default

Hierarchy

default
- default

Implements

default

Index

Constructors

constructor

Methods

_init create createID deg2rad deleteEntry deleteGroup distance read search update

Constructors

constructor

new default(): default
- Public Methods **
Returns default
Inherited from default.constructor
- Defined in src/DGElement.m.ts:27

Methods

`Protected` _init

_init(): void
- Protected Methods **
Returns void
Inherited from default._init
- Defined in src/DGElement.m.ts:18

create

create(entityName, keyName, data): Promise<object>
Create a new object in a database at entity[key].
Parameters
- entityName: string
  
  The name of the entity to create the object in.
- keyName: string
  
  The name of the key that the object will be stored under.
- data: object
  
  The data to store.
Returns Promise<object>
True if the data was successfully created, false otherwise.
Implementation of default.create
- Defined in src/DGLocalDatabase.m.ts:6

createID

createID(): string | number[]
Generate a random string of characters to be used as a unique id

Returns string | number[]
- The result of the call to the uuid function
Inherited from default.createID
- Defined in src/DGElement.m.ts:36

deg2rad

deg2rad(d): number
Convert an angle in degrees to radians
Parameters
- d: number
  
  the angle in degrees
Returns number
the angle in radians
Inherited from default.deg2rad
- Defined in src/DGElement.m.ts:46

deleteEntry

deleteEntry(entityName, keyName, fieldName): Promise<boolean>
Delete a single row or field from a database at entity[key].
Parameters
- entityName: string
  
  The name of the entity to delete the object from.
- keyName: string
  
  The name of the key that the object is stored under.
- fieldName: string
  
  The name of the key that the object is stored under.
Returns Promise<boolean>
True if the data was successfully deleted, false otherwise.
Implementation of default.deleteEntry
- Defined in src/DGLocalDatabase.m.ts:46

deleteGroup

deleteGroup(entityName, keyName): Promise<boolean>
Delete an entire group under entity[key].
Parameters
- entityName: string
  
  The name of the entity to delete.
- keyName: string
  
  The name of the key that the object is stored under.
Returns Promise<boolean>
True if the data was successfully deleted, false otherwise.
Implementation of default.deleteGroup
- Defined in src/DGLocalDatabase.m.ts:36

distance

distance(p1, p2): number
Calculate the linear distance between two points using the Haversine formula

Todo
Limit the coordinates to the min/max ranges

See
Point
Parameters
- p1: Point
  
  Point one
- p2: Point
  
  Point two
Returns number
The distance in km
Inherited from default.distance
- Defined in src/DGElement.m.ts:59

read

read(entityName, keyName): Promise<any>
Read an object from a database at entity[key].
Parameters
- entityName: string
  
  The name of the entity to read the object from.
- keyName: string
  
  The name of the key that the object is stored under.
Returns Promise<any>
The data stored at entity[key].
Implementation of default.read
- Defined in src/DGLocalDatabase.m.ts:16

search

search(entityName, keyName, needle, comparison, caseSensitive): Promise<boolean>
Search for an object in a database at entity[key] that matches the given criteria.

Throws
If the comparison is invalid.
Parameters
- entityName: string
  
  The name of the entity to search the object in.
- keyName: string
  
  The name of the key that the object is stored under.
- needle: string
  
  The value to search for.
- comparison: string
  
  The comparison to use when searching.
- caseSensitive: boolean
  
  Whether or not the search should be case sensitive.
Returns Promise<boolean>
True if the object was found, false otherwise.
Implementation of default.search
- Defined in src/DGLocalDatabase.m.ts:63

update

update(entityName, keyName, data): Promise<boolean>
Update an object in a database at entity[key].
Parameters
- entityName: string
  
  The name of the entity to update the object in.
- keyName: string
  
  The name of the key that the object is stored under.
- data: any
  
  The data to store.
Returns Promise<boolean>
True if the data was successfully updated, false otherwise.
Implementation of default.update
- Defined in src/DGLocalDatabase.m.ts:26

Class default

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Returns default

Methods

Protected _init

Returns void

create

Parameters

entityName: string

keyName: string

data: object

Returns Promise<object>

createID

Returns string | number[]

deg2rad

Parameters

d: number

Returns number

deleteEntry

Parameters

entityName: string

keyName: string

fieldName: string

Returns Promise<boolean>

deleteGroup

Parameters

entityName: string

keyName: string

Returns Promise<boolean>

distance

Todo

See

Parameters

p1: Point

p2: Point

Returns number

read

Parameters

entityName: string

keyName: string

Returns Promise<any>

search

Throws

Parameters

entityName: string

keyName: string

needle: string

comparison: string

caseSensitive: boolean

Returns Promise<boolean>

update

Parameters

entityName: string

keyName: string

data: any

Returns Promise<boolean>

Settings

Member Visibility

Theme

On This Page

`Protected` _init