maplicate-core 0.1.0 | Documentation

maplicate-core

0.1.0

MaplicateNode ▸
- Instance members
- #address
- #get
- #query
- #add
- #update
- #remove
- #close
- #drop

Need help reading this?

MaplicateNode

Maplicate node

new MaplicateNode(orbitdb: Object, nameOrAddress: string, options: any)

Extends EventEmitter

Parameters

orbitdb (Object) an orbit-db instance

nameOrAddress (string) maplicate node name or address

options

(any
            = {})

Instance Members

▸ address

Map address

address

Returns

string: unique map address

▸ get(id)

Get a map feature

get(id: string): Promise

Parameters

id (string) feature id

Returns

Promise: GeoJSON feature

▸ query(selector)

Get map features with a given selector function.

query(selector: function): Promise

Parameters

selector (function) a selector functiion

Returns

Promise: an array of GeoJSON features

▸ add(feature, options)

Add a map feature

add(feature: Feature, options: Object): Promise

Parameters

feature (Feature) GeoJSON feature

options

(Object
            = {})

options

Name	Description
options.disableEvent `boolean` (default `false`)	indicates whether to disable event

Returns

Promise: feature id

▸ update(id, feature, options)

Update a map feature

update(id: string, feature: Feature, options: Object): Promise

Parameters

id (string) feature id

feature (Feature) GeoJSON feature

options

(Object
            = {})

options

Name	Description
options.disableEvent `boolean` (default `false`)	indicates whether to disable event

Returns

Promise: no output

▸ remove(id, options)

Remove a map feature

remove(id: string, options: Object): Promise

Parameters

id (string) feature id

options

(Object
            = {})

options

Name	Description
options.disableEvent `boolean` (default `false`)	indicates whether to disable event

Returns

Promise: no output

▸ close()

Close the connection

close(): Promise

Returns

Promise: no output

▸ drop()

Drop local storage

drop(): Promise

Returns

Promise: no output