Get unlimited public & private packages + team-based management with npm Teams.Learn more »

commonform-predicate

3.0.1 • Public • Published
var predicate = require('commonform-predicate')

The exported functions can be used to find the type of a content array element in a known-valid form, to avoid doing all that's necessary to ensure validity.

If you a know a form object is valid, and need to pick out specific content elements, use commonform-predicate, not commonform-validate.

var assert = require('assert')
 
var invalid = { invalid: 'object' }
var validForm = { content: [ 'Valid text' ] }
 
assert(predicate.definition({ definition: 'Term' }))
assert(!predicate.definition(invalid))
 
assert(predicate.use({ use: 'Term' }))
assert(!predicate.use({ term: 'Term' }))
 
assert(predicate.reference({ reference: 'Term' }))
assert(!predicate.reference(invalid))
 
assert(predicate.blank({ blank: 'Value' }))
assert(!predicate.blank(invalid))
 
assert(predicate.child({ heading: 'Summary', form: validForm }))
assert(!predicate.child(invalid))
 
assert(predicate.component({
  heading: 'Warranty Disclaimer',
  repository: 'api.commonform.org',
  publisher: 'kemitchell',
  project: 'orthodox-software-copyright-license',
  edition: '1e',
  upgrade: 'yes',
  substitutions: {
    terms: {
      'Licensor': 'Vendor',
      'Licensee': 'Customer',
      'Program': 'Software'
    },
    headings: {
      'Express Warranties': 'Guarantees'
    }
  }
}))
 
assert(predicate.text('Text'))
assert(!predicate.text(null))

Install

npm i commonform-predicate

DownloadsWeekly Downloads

399

Version

3.0.1

License

BlueOak-1.0.0

Unpacked Size

4.2 kB

Total Files

4

Last publish

Collaborators

  • avatar