Class Spec

Abstract class representing Spec, the main specification of perusal. Declares the abstract method assert and explain which is used by the utility methods ofr validity checking and specification assertion on a given value.

Hierarchy

Spec
- And
- Or
- Pred
- Keys
- Optional
- Nullable
- OneOf
- Every

Constructors

constructor

Properties

name
options

Methods

Constructors

constructor

new Spec(name: string, options: any): Spec

- Defined in spec/spec.ts:13
Parameters
- name: string
- options: any
Returns Spec

Properties

name

name: string

options

options: any

Methods

assert

assert(value: any): any

- Defined in spec/spec.ts:26
Asserts this spec on a given value.

throws

Error on call - subclasses should all implement the assert method.

throws

Error on call - subclasses should all implement the assert method.

Parameters
- value: any
  
  The value to be asserted.
Returns any

explain

explain(value: any, path: String[]): void

- Defined in spec/spec.ts:42
Expplains why a given value passes/fails this spec.

throws

Error on call - subclasses should all implement the explain method.

throws

Error on call - subclasses should all implement the explain method.

Parameters
- value: any
  
  The value to be asserted.
- path: String[]
  
  The path travelled to this spec.
Returns void

Generated using TypeDoc