Installations

npm install @alifd/validate

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

14.17.1

NPM Version

7.20.2 Score

76.2

Supply Chain

95.9

Quality

85.3

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

13

Total

43

Closed

6

Merged

24

Issues

Open

1

Total

3

Closed

2

Releases

5

v1.1.4

Published on 11 Oct 2019

v1.1.3

Published on 20 Aug 2019

v1.1.2

Published on 01 Aug 2019

v1.1.1

Published on 30 Jul 2019

v1.1.0

Published on 25 Jul 2019

View all 5 releases

Contributors

11

Unable to fetch Contributors

View all 11 contributors

Languages

2

TypeScript

JavaScript

TypeScript (99.36%)

JavaScript (0.64%)

Developer

alibaba-fusion

Download Statistics

Total Downloads

848,938

Last Day

172

Last Week

1,179

Last Month

8,268

Last Year

127,515

GitHub Statistics

1 Stars

82 Commits

3 Forks

3 Watching

27 Branches

11 Contributors

Bundle Size

14.70 kB

Minified

3.90 kB

Minified + Gzipped

Bundlephobia

Maintainers

23

Package Meta Information

Latest Version

1.4.0

Package Id

@alifd/validate@1.4.0

Unpacked Size

95.76 kB

Size

24.45 kB

File Count

19

NPM Version

7.20.2

Node Version

14.17.1

Total Downloads

Cumulative downloads

Total Downloads

848,938

Last day

-56.9%

172

Compared to previous day

Last week

-57.6%

1,179

Compared to previous week

Last month

2.3%

8,268

Compared to previous month

Last year

-48.4%

127,515

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

22

Versions

Validate

Validation to be used with @alifd/field Install with npm install @alifd/validate

Basic Usage

Callback

const rules = {
  myInput: function (rule, value, cb, options) {
    if (value <= 100) {
      cb('Value must be more than 100');
    } else {
      cb();
    }
  }
}
const validator = new Validator(rules);
validator.validate({ myInput: 90 }, (err) => { console.log(err)});

Promise

const rules = {
  myInput: function (rule, value, cb, options) {
    if (value <= 100) {
      cb('Value must be more than 100');
    } else {
      cb();
    }
  }
}
const validator = new Validator(rules);
validator.validatePromise({ myInput: 90 })
  .then((err) => { console.log(err)})

API

Initialization

let validator = new Validator(rules [, options]);

Parameter	Description	Type	Optional	Default
rules	Map of rule names to validation functions	{ [ruleName] : Array of validation functions }	yes	undefined
options	validation options	Object	yes	{}

options configuration item

Parameters	Description	Type	Default
first	should only return the first error found amongst rules	Boolean	undefined
messages	map to override default messages	Object	(see ./src/messages)

Development

Testing

npm run test - triggers a one-time full run of all unit tests npm run test-watch - triggers a run of all unit tests, but watches for any changes to code or tests and reruns all tests.

Making commits

Commits must be in the following format TYPE(SCOPE): MESSAGE, where SCOPE is optional. e.g. fix: validatePromise return value Review the commitlint.config.js file to see allowed types.

Release

There are 2 main branches: Master and Develop. Master holds the latest code that is contained in the npm package. Develop is the development branch used for queueing package changes and any final validation. All development should occur on another branch and then be merged into Develop.

Travis CI will run tests on each pull request and push. If the push is to master then an additional release step runs. The release step uses semantic-release to determine the correct version, tag the master branch, and release the new package to npm.

NOTE: the package.json file needs to be updated manually after the release.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

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.

2

Code-Review

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

2

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

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

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.1

/10

Last Scanned on 2025-01-27

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