Class Restriction

A query restriction.

Hierarchy

Restriction

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Restriction(attribute: string, comparator: Comparator, value?: any): Restriction

- Defined in api/Restriction.ts:46
Parameters
- attribute: string
- comparator: Comparator
- Optional value: any
Returns Restriction

Properties

attribute

attribute: string

The model attribute (name, id, etc.) to query.

comparator

comparator: Comparator

The comparator to use when querying.

Optional value

value: any

The value to compare the attribute property to.

Methods

toString

toString(): string

- Defined in api/Restriction.ts:55
A human-readable string for this restriction.

Returns string

Static fromJson

fromJson(restriction: any): Restriction

- Defined in api/Restriction.ts:13
Given a restriction JSON structure, return a Restriction object.

Parameters
- restriction: any
Returns Restriction

Static fromString

fromString(filter: string): Restriction

- Defined in api/Restriction.ts:21
Convert a filter string into a restriction.

Parameters
- filter: string
Returns Restriction

Generated using TypeDoc