THIS LIBRARY IS CURRENTLY UNSTABLE! USE AT YOUR OWN RISK!
Checkpoint.js
Validate and transform data.
Setup
Download
Install the checkpointjs
package with a package manager like npm or Yarn.
You can also download and extract a release from here from the Checkpoint.js GitHub repository releases page.
Using the Library
The library can be used in two different ways:
Direct Function Import
const data = foo: 'bar' 123: 456 const result =
Checkpoint Instantiation
const data = foo: 'bar' 123: 456 const result =
Note: This library supports TypeScript. The source is completely written in it. Declaration files are included in the dist/
folder.
API
Validate
Validates the input data. Returns the results of the validation.
Functions
// Direct Function Import // Checkpoint Instantiation
Result
TODO
Schema
allowNull
- Description: Determines if a null value is allowed.
- Type:
boolean
- Default:
false
// Primitiveconst primitiveData = nullconst primitiveValidationResult = console // true // Objectconst objectData = foo: null const objectValidationResult = console // true // Array of primitivesconst primitiveArrayData = null nullconst primitiveArrayValidationResult = console // true // Array of objectsconst objectArrayData = foo: null foo: null const objectArrayValidationResult = console // true
isRequired
- Description: Determines if the value is required.
- Type:
boolean
- Default:
false
// Primitiveconst primitiveData = 123const primitiveValidationResult = console // true // Objectconst objectData = foo: 123 const objectValidationResult = console // true // Array of primitivesconst primitiveArrayData = 123 456const primitiveArrayValidationResult = console // true // Array of objectsconst objectArrayData = foo: 123 foo: 456 const objectArrayValidationResult = console // true
stringValidation
TODO
type
- Description: Requires a matching type for the value.
- Type:
string
// Primitiveconst primitiveData = 'foo'const primitiveValidationResult = console // true // Objectconst objectData = foo: 123 const objectValidationResult = console // true // Array of primitivesconst primitiveArrayData = true falseconst primitiveArrayValidationResult = console // true // Array of objectsconst objectArrayData = foo: 'bar' foo: 'baz' const objectArrayValidationResult = console // true
Options
exitASAP
TODO
requireMode
TODO
Transform
Transforms and mutates the input data. Returns the transformed data.
Functions
// Direct Function Import // Checkpoint Instantiation
Commands
clean
- Description: Removes undefined values.
// Objectconst objectData = a: 123 b: undefined c: 456 d: 789 e: undefined console // { a: 123, c: 456, d: 789 }
replace
- Description: Replaces values with another value.
// Objectconst objectData = a: 123 b: 456 c: 789 console // { a: 123, c: 'xyz', d: 789 }
trim
- Description: Trims whitespace from strings.
// Objectconst objectData = a: 'hey ' b: ' ho' c: ' let\'s go ' console // { a: 'hey', c: 'ho', d: 'let\'s go' }
Checkpoint
TODO
License
This open source project is licensed under the MIT License.