import Api from 'schema-mapper-api'

public class | source

Api

Main interface to communicate with a store

Constructor Summary

Public Constructor
public	constructor(url: String) Create a new Api instance

Member Summary

Public Members
public	projectCollection: ProjectCollection Cached ProjectCollection

Protected Members
protected	websocketClient: WebsocketClient Websocket client used for communication with a store

Method Summary

Public Methods
public	applyChange(change: Change): Promise Apply a change to the store
public	applyChanges(changes: Changes): Promise Apply multiple changes to the store
public	createPutItemStream(projectId: String, schemaId: String, projectVersion: Number, listen: Boolean): Stream Create a write stream to store items
public	delItem(projectId: String, schemaId: String, itemId: String): Promise Remove an item
public	getAllProjects(): Object Retrieve all projects at all versions
public	getProjectCollection(): ProjectCollection Retrieve a ProjectCollection
public	on(topic: String, cb: Function) Listen to events from the store
public	putItem(projectId: String, schemaId: String, item: Item, projectVersion: Number): Promise Store an item

Protected Methods
protected	handleResponse(response: Object): * Handles websocket result

Public Constructors

public constructor(url: String) source

Create a new Api instance

Params:

Name	Type	Attribute	Description
url	String		The store server url to connect to

Public Members

public projectCollection: ProjectCollection source

Cached ProjectCollection

Protected Members

protected websocketClient: WebsocketClient source

Websocket client used for communication with a store

Public Methods

public applyChange(change: Change): Promise source

Apply a change to the store

Params:

Name	Type	Attribute	Description
change	Change

Return:

Promise

public applyChanges(changes: Changes): Promise source

Apply multiple changes to the store

Params:

Name	Type	Attribute	Description
changes	Changes		Array of changes

Return:

Promise

public createPutItemStream(projectId: String, schemaId: String, projectVersion: Number, listen: Boolean): Stream source

Create a write stream to store items

Params:

Name	Type	Attribute	Description
projectId	String
schemaId	String
projectVersion	Number
listen	Boolean		Whether you want to listen for results or not

Return:

Stream

Stream that accepts items as a JSON object

public delItem(projectId: String, schemaId: String, itemId: String): Promise source

Remove an item

Params:

Name	Type	Attribute	Description
projectId	String
schemaId	String
itemId	String

Return:

Promise

public getAllProjects(): Object source

Retrieve all projects at all versions

Return:

Object

All projects

public getProjectCollection(): ProjectCollection source

Retrieve a ProjectCollection

Return:

ProjectCollection

public on(topic: String, cb: Function) source

Listen to events from the store

Params:

Name	Type	Attribute	Description
topic	String		Topic to listen to
cb	Function		Callback to call when an event has happened

public putItem(projectId: String, schemaId: String, item: Item, projectVersion: Number): Promise source

Store an item

Params:

Name	Type	Attribute	Description
projectId	String
schemaId	String
item	Item
projectVersion	Number

Return:

Promise

Protected Methods

protected handleResponse(response: Object): * source

Handles websocket result

Params:

Name	Type	Attribute	Description
response	Object

Return:

Result