@capsulajs/capsulahub-service-selector

Selector service

The purpose of this service is to provide a utility tool that allows user to select a specific data inside a collection of data.

Install

NPM

To install the package from NPM registry you should run

yarn add @capsulajs/capsulahub-service-selector

or

npm install @capsulajs/capsulahub-service-selector

CDN

You can get the default export from the link

https://capsulajs.s3.amazonaws.com/develop/capsulahub-service-selector/index.js

WorkspaceConfiguration example

{
  "services": [
    {
      "serviceName": "SelectorService",
      "path": "https://capsulajs.s3.amazonaws.com/develop/capsulahub-service-selector/index.js",
      "definition": {
        "serviceName": "SelectorService",
        "methods": {
          "setItems": { "asyncModel": "requestResponse" },
          "items$": { "asyncModel": "requestStream" },
          "selectItem": { "asyncModel": "requestResponse" },
          "selectedItem$": { "asyncModel": "requestStream" }
        }
      },
      "config": { "serviceName": "SelectorService" }
    }
  ]
}

Exports

Default

Bootstrap function of the extension.

Named (API)

The public API of the extension.

Usage

This service takes two typed elements (Item and Key).

interface Item {
  name: string;
  age: number;
  role: string;
}

interface Key {
  name: string;
}

const data = [
  { name: 'Pim', age: 22, role: 'first' },
  { name: 'Pam', age: 42, role: 'second' },
  { name: 'Pom', age: 32, role: 'third' },
];
// Init selector with typed elements
const selector = new Selector<Item, Key>();
// Fill the selector with data
selector.setItems({ items: data })
  .then(() => console.log(`setItems completed`));
// Subscribe to selector's data
selector.items$({}).subscribe(console.log);
// Output 
// [ { name: 'Pim', age: 22, role: 'first' },
//   { name: 'Pam', age: 42, role: 'second' },
//   { name: 'Pom', age: 32, role: 'third' } ]

// Select an Item
selector.selectItem({ key: { name: 'Pim' }})
  .then(() => console.log(`Item selected`));
// Subscribe to selector selected item
selector.selectedItem$({}).subscribe(console.log);
// Output
// { name: 'Pim', age: 22, role: 'first' }

API

CDN

The documentation about public API.

Local

Run

yarn doc

And open doc/index.html in browser.

Test

npm run test or yarn test

Licence

CapsulaHub and related services are released under MIT Licence.

Back to the Main Page