Installations

npm install ynn-http-assert

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=8.0

Node Version

13.5.0

NPM Version

6.13.6 Pull Requests

Open

11

Total

12

Closed

1

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

1

JavaScript

JavaScript (100%)

Developer

ynnjs

Download Statistics

Total Downloads

0

Last Day

0

Last Week

0

Last Month

0

Last Year

0

GitHub Statistics

MIT License

14 Commits

1 Watchers

12 Branches

1 Contributors

Updated on Jan 31, 2020

Maintainers

1

View All 1 Contributors

Package Meta Information

Latest Version

0.0.6

Package Id

ynn-http-assert@0.0.6

Unpacked Size

13.03 kB

Size

4.19 kB

File Count

7

NPM Version

6.13.6

Node Version

13.5.0

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

0%

NaN

Compared to previous day

Last Week

0%

NaN

Compared to previous week

Last Month

0%

NaN

Compared to previous month

Last Year

0%

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

3

@lvchengbin/is deep-equal http-errors

Dev Dependencies

3

eslint jest pre-commit

ynn-http-assert

Like http-assert, but has more features for using in some web frameworks, such as Koa.

Installation

1$ npm i --save ynn-http-assert

Usage

1const koa = require( 'koa' );
2const assert = require( 'ynn-http-assert' );
3
4const app = new Koa();
5
6app.use( async ( ctx, next ) => {
7    const id = assert( ctx.query.id, 400, 'id is required' )
8        .is( 'int', 'invalid id' )
9        .between( [ 100, 1000 ] )
10        .value();
11
12    const pn = assert( ctx.query.pn )
13        .default( 1 )
14        .is( 'int' )
15        .gt( 0 )
16        .value();
17
18    const email = assert( ctx.query.email, 400, 'email is required' )
19        .is( 'email' )
20        .custom( v => v.startWith( 'abc' ) )
21        .value();
22
23    const username = await assert( ctx.query.username )
24        .custom( v => {
25            return Promise.reject();
26        }, 400, 'username is invalid' )
27        .value();
28
29    return next();
30} );

API

assert(value, [status], [message], [properties])

Assertion

default(value)

To set a default value if the value doesn't pass any of the assertions, and then all the assertions rest will be ignored.

1const x = assert( ctx.query.x ) // if the ctx.query.x is not truthy, the value will be set to 100
2    .default( 100 )
3    .is( 'int' ) // if the value is not an integer, the value will be set to 100
4    .value();

value([v])

To set/get the value of Assertion instance.

1const x = assert( ctx.query.x )
2    .custom( function( v ) { 
3        this.value( 'new-value' );  // to set the value to 'new-value'
4    } ).
5    value(); // to get the value

equal(data, [status], [message], [properties])

notEqual(data, [status], [message], [properties])

strictEqual(data, [status], [message], [properties])

notStrictEqual(data, [status], [message], [properties])

deepEqual(data, [status], [message], [properties])

notDeepEqual(data, [status], [message], [properties])

is(type, [status], [message], [properties])

gt(n, [status], [message], [properties])

gte(n, [status], [message], [properties])

lt(n, [status], [message], [properties])

lte(n, [status], [message], [properties])

between(interval, [status], [message], [properties])

length(interval, [status], [message], [properties])

regex(regex, [status], [message], [properties])

json(fn, [status], [message], [properties])

jsonstr(fn, [status], [message], [properties]) custom(fn, [status], [message], [properties])

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.7

/10

Last Scanned on 2025-06-30

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More