Skip to content

Latest commit

 

History

History
101 lines (68 loc) · 2.81 KB

README.md

File metadata and controls

101 lines (68 loc) · 2.81 KB


@fullstacksjs/toolbox logo


download status version Code Coverage MIT License semantic-release

Welcome to Toolbox! A zero-dependency 📦 tree-shakable🌲 collection of missing JavaScript utilities.

Table of Contents

Installation

NodeJS

$ npm install --save-dev @fullstacksjs/toolbox

Deno

import * as toolbox from 'https://raw.githubusercontent.com/fullstacksjs/toolbox/main/mod.ts'

Browser

<script src='https://www.unpkg.com/@fullstacksjs/toolbox/iife/index.js'></script>
<script>
  console.log(window.Toolbox)
</script>

Contributing

Development of toolbox happens in GitHub, and we appreciate contributions.

Prerequisite

Pull Request

The FullstacksJS team is monitoring for pull requests. We will go ahead and review your pull request as soon as possible.

Before submitting a pull request, please make sure the following is done:

  • Fork the repository and create your feature branch from dev.
  • Run npm install to have all dependencies.
  • To start development run npm run test:watch.
  • Write tests in src/<scope>/<name>.test.ts and implementation in src/<scope>/<name>.ts.
  • Add the documentation page to the docs/<scope>/<function>.mdx and update docs/<scope>/_meta.json file.
  • Ensure everything is ok npm run verify.

Code of Conduct

FullstacksJS Rules Page

Documentation

Please check out the documentation page