Skip to content
/ pakal Public

Pakal is utilities modules, written in typescript.

License

Notifications You must be signed in to change notification settings

yisraelx/pakal

Repository files navigation

Pakal

Travis build Codecov MIT License TypeScript Commitizen friendly Lerna Tested With Jest

Pakal is utilities modules, written in typescript.

Packages structure

  • The code is divided into many small modules and each module is a package in itself (Packages List).
  • Each package in the scoop has only one function or class and it in the default export of the package.
  • Group package brings together several modules from the scope, and in the export has access to all modules.

Marks:

  • "-": @{scope}/-{name} - Group package
  • "_": @{scope}/_{name} - Internal package

Install

$ npm install --save @pakal/-all

Or install only the module you need

$ npm install --save @pakal/for-each

Use

Modules

import { forEach } from '@pakal/-all';

Or import only the module you need

import { default as forEach } from '@pakal/for-each';

Browser

<script src="https://unpkg.com/@pakal/-all/bundle.umd.min.js"><script>

Or import only the module you need

<script src="https://unpkg.com/@pakal/for-each/bundle.umd.min.js"><script>
let { forEach } = _;

Compatibility

These modules are written in typescript and available in ES5 and ES6 standard.

  • main - commonjs module and es5 standard (index.js)
  • module - es2015 module and es5 standard (index.esm.js)
  • esnext - es2015 module and current es standard (index.es.js)
  • browser - bundle in umd format includes all dependencies in es5 standard (bundle.umd.js, bundle.umd.min.js)
  • types - typescript declaration file (index.d.ts)

Contribute

Pull requests are welcome!

Install - it will install the dependencies and link all workspaces packages.

$ yarn install

Test - it will run all workspaces tests.

$ yarn test

Build - it will build all the packages for release.

$ yarn build

License

Copyright © Yisrael Eliav, Licensed under the MIT license.