Package Exports

@comake/skql-js-engine
@comake/skql-js-engine/dist/index.js
@comake/skql-js-engine/dist/util/Types
@comake/skql-js-engine/dist/util/Types.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@comake/skql-js-engine) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

SKQL Javascript Engine

This is a Javascript implementation of a Standard Knowledge Query Language Engine for Standard Knowledge Language (SKL). It is written in Typescript and follows the SKL Engine specification.

How to use SKQL Javascript Engine

1. Install via npm or yarn:

npm install @comake/skql-js-engine
yarn add @comake/skql-js-engine

2. Define Schemas

We will be posting more documentation on schemas soon.

3. Write code

Once you have schemas defined for your domain, all you have to do is write code using the Verbs and Nouns in your schema to build your application logic.

Browser support

To use SKQL Javascript Engine in a browser, you'll need to use a bundling tool such as Webpack, Rollup, Parcel, or Browserify. Some bundlers may require a bit of configuration, such as setting browser: true in rollup-plugin-resolve.

How to contribute

To clone the repo, execute the following commands in your terminal:

git clone https://github.com/comake/skql-js-engine.git
cd skql-js-engine
npm ci

License & Copyright

SKQL Javascript Engine is open-source with certain limitations. See the LICENSE file for more info.

TODO

add SKDS schema source
Add reference to examples in readme