OData Filter Validation

• Installation
• Usage
• Contributing
• License
• Documentation

Installation

See INSTALL.md for full instructions.

Usage

Package Installation

npm i @odata-filter/validation --save

Basic Example

import { validate } from '@odata-filter/validation';

const ast = {
    type: 'comparison_operator',
    value: 'gte',
    left: { type: 'field', value: 'age' },
    right: { type: 'number_value', value: 'twenty one' }
}

validate(ast, {
  age: {
    type: 'number'
  }
});

// Error: Operator of type gte expects number_value, received string_value

trim() Example

import { tokenize, parse } from '@odata-filter/core';
import { validate } from '@odata-filter/validation';

const ast = parse(tokenize("trim(CompanyName) eq 'Alfreds Futterkiste'"));

validate(ast, {
  CompanyName: {
    type: 'string'
  }
});
// passes — trim() is unwrapped and CompanyName is validated as string

Contributing

See CONTRIBUTING.md for full instructions.

License

See LICENSE for licensing information.

Documentation

• OData Standard v4
• JSONSchema