@smapiot/piral-cloud-node

Node-usable API Client for the Piral Feed Service.

This package is compatible with Node.js v12 or higher.

Important Links

• 📢 We are hiring! - work with us on Piral, its ecosystem and our users
• 🌍 Website - learn more about the Piral Feed Service
• 📖 Documentation - everything to get started and master the Piral Feed Service
• 👪 Community Chat - ask questions and provide answers in our Gitter room

Installation

The package can be installed with your favorite npm client, e.g.:

npm i @smapiot/piral-cloud-node

Once installed the package is ready to be used.

Usage

To use the package you need to import the createServiceClient function and call it:

const { createServiceClient } = require('@smapiot/piral-cloud-node');

const client = createServiceClient({
  apiKey: '123...',
});

// use the client

If you want to use it with your own Piral Feed Service instance then provide the host option:

const { createServiceClient } = require('@smapiot/piral-cloud-node');

const client = createServiceClient({
  apiKey: '123...',
  host: 'http://localhost:9000',
});

// use the client

Example

If you want to just manipulate a feed you can go ahead and use the doUpdateFeed function.

const { createServiceClient } = require('@smapiot/piral-cloud-node');

const client = createServiceClient({
  apiKey: '123...',
});

const feedId = 'my-feed';

console.log('Before', await client.doQueryFeed(feedId));

await client.doUpdateFeed(feedId, {
  contributors: ['[e-mail]', '[e-mail]'],
});

console.log('After', await client.doQueryFeed(feedId));

Everything is fully typed using TypeScript declarations.

License

This SDK is released using the MIT license. For more information see the license file.