minibase-assert
v1.0.2
Plugin for [minibase][] and [base][], that adds assertion methods - most of [assert-kindof][] methods and built-ins assert module.
0/weekUpdated 3 years agoMIT
Published by Charlike Mike Reagent
npm install minibase-assert
minibase-assert   [![npm total downloads][downloads-img]][downloads-url]
> Plugin for [minibase][] and [base][], that adds assertion methods - most of [assert-kindof][] methods and built-ins assert module.
[![code climate][codeclimate-img]][codeclimate-url]
[![standard code style][standard-img]][standard-url]
[![linux build status][travis-img]][travis-url]
[![windows build status][appveyor-img]][appveyor-url]
[![coverage status][coveralls-img]][coveralls-url]
[![dependency status][david-img]][david-url]
You might also be interested in is-kindof.
Table of Contents
- Install
- Usage
- Related
- Contributing
- Building docs
- Running tests
- Author
- License
_(TOC generated by verb using markdown-toc)_
Install
Install with npm
``
$ npm install minibase-assert --save
or install using yarn
`
$ yarn add minibase-assert
Usage
> For more use-cases see the tests. Includes all of the [assert-kindof][] methods and all of the core assert
's methods.`js
const minibaseAssert = require('minibase-assert')
const MiniBase = require('minibase').MiniBase
const app = new MiniBase()app.use(minibaseAssert())
app.assert.object(null) // => throws AsserionError: null !== object
app.assert.object(123) // => throws AsserionError: number !== object
app.assert.object([1, 2, 3]) // => throws AsserionError: array !== object
app.assert.array(123) // => throws AsserionError: number !== array
app.assert.array([1, 2, 3]) // => does not throws
app.assert.number(123) // => does not throws
app.assert.object({ a: 'b' }) // => does not throws
`Hint: Use
if you want type checking and need to return true/false values without throwing AssertionError, because it is based on [is-kindof][] which in turn uses [kind-of][] behind the scenes!Related
- always-done: Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement for [async-done][] - pass 100… more | homepage
- minibase-better-define: Plugin for [base][] and [minibase][] that overrides the core .define method to be more better. | .define method to be more better."" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">homepage
- minibase-create-plugin: Utility for [minibase][] and [base][] that helps you create plugins | homepage
- minibase-is-registered: Plugin for [minibase][] and [base][], that adds isRegistered method to your application to detect if plugin is already registered and returns true or false if… more | isRegistered method to your application to detect if plugin is already registered and returns true or false if named plugin is already registered on the instance."" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">homepage
- minibase-results: Plugin for [minibase][] that adds useful initial properties for test results | homepage
- minibase-tests: Tests for applications built on [minibase][] or [base][]. All Base apps passes these tests. | homepage
- minibase-visit: Plugin for [minibase][] and [base][], that adds .visit method to your application to visit a method over the items in an object, or map visit… more | .visit method to your application to visit a method over the items in an object, or map visit over the objects in an array. Using using [collection-visit][] package."" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">homepage
- minibase: Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing [base][] plugins. | homepageContributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guidelines for advice on opening issues, pull requests, and coding standards.In short: If you want to contribute to that project, please follow these things
1. Please DO NOT edit README.md, CHANGELOG.md and .verb.md files. See "Building docs" section.
2. Ensure anything is okey by installing the dependencies and run the tests. See "Running tests" section.
3. Always use
npm run commit to commit changes instead of git commit, because it is interactive and user-friendly. It uses [commitizen][] behind the scenes, which follows Conventional Changelog idealogy.
4. Do NOT bump the version in package.json. For that we use npm run release, which is [standard-version][] and follows Conventional Changelog idealogy.Thanks a lot! :)
Building docs
Documentation and that readme is generated using [verb-generate-readme][], which is a [verb][] generator, so you need to install both of them and then run verb command like that`
$ npm install verbose/verb#dev verb-generate-readme --global && verb
_Please don't edit the README directly. Any changes to the readme must be made in .verb.md._
Running tests
Clone repository and run the following in that cloned directory
$ npm install && npm test
Author
Charlike Mike Reagent
+ github/tunnckoCore
+ twitter/tunnckoCore
License
Copyright © 2016, Charlike Mike Reagent. Released under the MIT license.
*
_This file was generated by verb-generate-readme, v0.2.0, on November 17, 2016._
[assert-kindof]: https://github.com/tunnckocore/assert-kindof
[async-done]: https://github.com/gulpjs/async-done
[base]: https://github.com/node-base/base
[collection-visit]: https://github.com/jonschlinkert/collection-visit
[commitizen]: https://github.com/commitizen/cz-cli
[is-kindof]: https://github.com/tunnckocore/is-kindof
[kind-of]: https://github.com/jonschlinkert/kind-of
[minibase]: https://github.com/node-minibase/minibase
[standard-version]: https://github.com/conventional-changelog/standard-version
[verb-generate-readme]: https://github.com/verbose/verb-generate-readme
[verb]: https://github.com/verbose/verb
[downloads-url]: https://www.npmjs.com/package/minibase-assert
[downloads-img]: https://img.shields.io/npm/dt/minibase-assert.svg
[codeclimate-url]: https://codeclimate.com/github/node-minibase/minibase-assert
[codeclimate-img]: https://img.shields.io/codeclimate/github/node-minibase/minibase-assert.svg
[travis-url]: https://travis-ci.org/node-minibase/minibase-assert
[travis-img]: https://img.shields.io/travis/node-minibase/minibase-assert/master.svg?label=linux
[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/minibase-assert
[appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/minibase-assert/master.svg?label=windows
[coveralls-url]: https://coveralls.io/r/node-minibase/minibase-assert
[coveralls-img]: https://img.shields.io/coveralls/node-minibase/minibase-assert.svg
[david-url]: https://david-dm.org/node-minibase/minibase-assert
[david-img]: https://img.shields.io/david/node-minibase/minibase-assert.svg
[standard-url]: https://github.com/feross/standard
[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg