ui-predicate-core

Low-level ui-predicate API.

Installation

ui-predicate is available on npm repository.

using yarn:

$ yarn add ui-predicate-core

using npm:

$ npm install ui-predicate-core

You can also directly download sources or use bundles available on jsDelivr.

Usage

ES modules:

import {PredicateCore} from 'ui-predicate-core'

PredicateCore({
  data: [/* */],
  config:{ /* ... */ }
}).then(api => {
  // use api here
  console.log(api);
}, error => {
  // UIPredicateCore will yield a rejected promise if something went wrong at initialization time
  console.error(error);
});

CommonJS:

const {PredicateCore} = require('ui-predicate-core');

PredicateCore({
  data: [/* */],
  config:{ /* ... */ }
}).then(api => {
  // use api here
  console.log(api);
}, error => {
  // UIPredicateCore will yield a rejected promise if something went wrong at initialization time
  console.error(error);
});

Example

Learn more about what ui-predicate can do in the Getting started.

Feel free to try ui-predicate on runkit.

Documentation

API

The detailed generated API documentation is available here.

Looking for older versions API documentation? Links are available here.

Contributing

We want contributing to ui-predicate to be fun, enjoyable, and educational for anyone, and everyone.

Code of Conduct

In the interest of fostering an open and welcoming environment, we have adopted a Code of Conduct that we expect project participants to commit to. Please read the full text so that you can understand what behavior will and will not be tolerated.

Contributing guide

If you are interested in contributing to ui-predicate, please read our contributing guide to learn more about how to suggest bugfixes and improvements.

License

ui-predicate is MIT licensed.