open-index/open-npm huggingface dataset:
npm package: @smartcloud/datastore
Description: Google Datastore Module of SmartCloud Utility Library for Node.js
Author: Smart Parking Ltd
Latest version: 0.0.8

# @smartcloud/datastore

Google Cloud Datastore Module of SmartCloud Utility Library for Node.js

Methods are exposed through Javascript object called CloudDatastore

### npm installation
```sh
$ npm install --save @smartcloud/datastore
```

### Class

The module has core class named "**CloudDatastore**".  To initialize an **CloudDatastore** object, pass the follow parameters.

    * aggregateType - (required) specify aggregateType which is also used as target EntityKind in Google cloud datastore. 

    * maxRetries - (optional) specify maximum number of times that process can retry in case of failure.  If not specified, default will be 10.

    * indexColumns - (optional) specify array of property names which need to be indexed.

### Sample usage
```js
const SmartCloudDatastore = require('@smartcloud/datastore');

var client = new SmartCloudDatastore.CloudDatastore({
    aggregateType: 'Foo',
    indexColumns: ['foo1', 'foo2']
});
```

### Methods

* datastoreKey(keyOptions) *method* - Return Google datastore key based on keyOptions given.  For keyOptions structure, follow Google datastore key.

* datastore() *method* - Return current datastore instance associated with current CloudDatastore instance

* convertObjectToUnindexedData() *method* - Unindex all the properties of the object targeted to persist in Google datastore excluding properties specified through **indexColumns** during CloudDatastore object initialization

* saveRecord(entity, path) *method* - Save specified entity into Google datastore.

* queryDatastore(query) *method* - Run Google datastore query

* loadFromDatastore(key) *method* - Get object from Google datastore

* deleteFromDatastore(key) *method* - Delete object from Google datastore

* saveRecords(entities) *method* - Save multiple entities into Google datastore
npm package: @smartcloud/memcached
Description: Memcached Module of SmartCloud Utility Library for Node.js
Author: Smart Parking Ltd
Latest version: 0.0.5

# @smartcloud/memcached

Memcached Module of SmartCloud Utility Library for Node.js

### npm installation
```sh
$ npm install --save @smartcloud/memcached
```

### Initialization

The module has core class named "**Memcached**".  To initialize an **Memcached** object, pass the follow parameters.

    * host - (required) specify relevant memcached host. 

    * port - (required) specify relevant memcached port. 

    * entityKind - (optional) specify entityKind which is also used as target EntityKind in Google cloud datastore. If not defined, "Memcached" will be target entity kind.

    * maxRetries - (optional) specify maximum number of times that process can retry in case of failure.  If not specified, default will be 10.

### Sample usage
```js
const SmartCloudMemcached = require('@smartcloud/memcached');

var client = new SmartCloudMemcached.Memcached({
    host: 'host',
    port: 1234
});
```

### Methods

* memcached() *method* - Return current memcached instance associated with current Memcached instance

* get(key) *method* - Return related value (if any) for specified key.

* set(key, value) *method* - Store key-value pair.

* delete(key) *method* - Delete key-value pair (if any) for specified key.
npm package: @smartcloud/operations
Description: Operations Module of SmartCloud Utility Library for Node.js
Author: Smart Parking Ltd
Latest version: 0.0.3

# @smartcloud/operations

Operations Module of SmartCloud Utility Library for Node.js

### npm installation
```sh
$ npm install --save @smartcloud/operations
```

### Initialization

The module has core class named "**SmartCloudOperations**".  To initialize an **SmartCloudOperations** object, pass the follow parameters.

    * maxRetries - (optional) specify maximum number of times that process can retry in case of failure.  If not specified, default will be 10.

### Sample usage
```js
const SmartCloudOps = require('@smartcloud/operations');

var ops = new SmartCloudOps.SmartCloudOperations();
```

### Methods

* updateOperation(operationDetails) *method* - Update operation based on operation details passed.
        * Expected operationDetails' properties
            * **functionName** - function name related to this operation
            * **status** - current operation's relevant status
            * **message** - update message
            * **fact** - relevant generic SmartCloud fact details
npm package: @smartcloud/pubsub-listener
Description: Pubsub Listener Module of SmartCloud Utility Library for Node.js
Author: Smart Parking Ltd
Latest version: 0.0.7

# @smartcloud/pubsub-listener

Pubsub listener Module of SmartCloud Utility Library for Node.js

### npm installation
```sh
$ npm install --save @smartcloud/pubsub-listener
```

### Initialization

The module has core class named "**PubsubListener**".  To initialize an **PubsubListener** object, pass the follow parameters.

    * trigger - (required) target pubsub name.

    * listenerName - (required) listener process name

    * targets - (required) listener's targets

    * filter - (optional) filters

### Sample usage
```js
const SmartCloudPubsubListener = require('@smartcloud/pubsub-listener');

var listener = new SmartCloudPubsubListener.PubsubListener();
```

### Methods

* getMessage(event) *method* - Return message details (event id, attributes, and message) based on pubsub event passed.
npm package: @smartcloud/pubsub-publisher
Description: Pubsub Publisher Module of SmartCloud Utility Library for Node.js
Author: Smart Parking Ltd
Latest version: 0.0.3

# @smartcloud/pubsub-publisher

Pubsub publisher Module of SmartCloud Utility Library for Node.js

### npm installation
```sh
$ npm install --save @smartcloud/pubsub-publisher
```

### Initialization

The module has core class named "**PubsubPublisher**".  To initialize an **PubsubPublisher** object, pass the follow parameters.

    * maxRetries - (optional) specify maximum number of times that process can retry in case of failure.  If not specified, default will be 10.


### Sample usage
```js
const SmartCloudPubsubPublisher = require('@smartcloud/pubsub-publisher');

var publisher = new SmartCloudPubsubPublisher.PubsubPublisher();
```

### Methods

* pubsub() *method* - Return pubsub instance associated with current PubsubPublisher instance.

* publish(topic, message) *method* - Publish message to specified topic.