npm

Need private packages and team management tools?Check out npm Orgs. »

@agrarium/core

2.0.2 • Public • Published

Agrarium Core

Agrarium stream engine wich provides interface for microplugins infrastructure. Every plugin can get any data from any resource. Usually it is file system, but it also can be remote resource or whatewhere you want ;) Read more about plugins API here and write your own the best plugin!

Usage

$ npm i agrarium

Or use it standalone:

npm i @agrarium/core

Anywhere in your code:

const { agrarium, PluginDTS } = require('agrarium');
 
agrarium({
    src: ['./src/components'],
    plugins: [
        new PluginDTS({/* options */})
    ]
});

Options

src: string[]

Set of paths to the sources.

plugins: IPlugin[]

Set of plugins or presets.

transform?: (chunk: IChunk) => {}

Use this function if you need to transform chunk. For example you can add or remove any data from every chunk.

cwd?: string

Custom path to project cwd.

groupBy?: (file: BEMSDK.IFile) => string

Use this function to sort and group found entties. Grouped by component by default.

Types Definitions

All interfaces defined in the public package [@agrarium/types](../types/index.d.ts).

License MIT

Keywords

none

install

npm i @agrarium/core

Downloadsweekly downloads

3,514

version

2.0.2

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
Report a vulnerability