Odata-filter-to-ast NPM

odata-filter-to-ast

Simple OData query parser with zero dependencies.

npm version MIT license GitHub code size in bytes npm

Usage

$ npm install odata-filter-to-ast

Usage in code:

import {parseFilter, parseOrderBy} from 'odata-filter-to-ast';

parseFilter(`Name gt "Milk" or Price lt -2.55 or Size ne 3`);
parseOrderBy(`age,sum(height,width) desc`);

Result:

{
	type: 'OrExpr',
	left: {
		type: 'GtExpr',
		left: {
			type: 'MemberExpr',
			value: 'Name',
		},
		right: {
			type: 'Primitive',
			value: 'Milk'
		},
	},
	right: {
		type: 'OrExpr',
		left: {
			type: 'LtExpr',
			left: {
				type: 'MemberExpr',
				value: 'Price',
			},
			right: {
				type: 'Primitive',
				value: -2.55
			}
		},
		right: {
			type: 'NeExpr',
			left: {
				type: 'MemberExpr',
				value: 'Size',
			},
			right: {
				type: 'Primitive',
				value: 3
			}
		}
	}
}
[
	{
		type: 'OrderByItem',
		expr: {
			type: 'MemberExpr',
			value: 'age',
		},
		dir: 'asc',
	},
	{
		type: 'OrderByItem',
		expr: {
			type: 'FunctionExpr',
			name: 'sum',
			arguments: [
				{
					type: 'MemberExpr',
					value: 'height',
				},
				{
					type: 'MemberExpr',
					value: 'width',
				},
			],
		},
		dir: 'desc',
	},
]