Options
All
  • Public
  • Public/Protected
  • All
Menu

Used to express a group of patterns to match.

Hierarchy

Index

Properties

Optional @context

@context: Context

A JSON-LD Context for the query. In an API, this will frequently be implicit. For example, using json-rql as the body of a POST to http://example.com/my-api/v1/person/query might have the implicit context of a Person (possibly found at http://example.com/my-api/v1/person).

see

examples https://github.com/gsvarovsky/json-rql/search?l=JSON&q=context&type=Code

Optional @filter

@filter: Constraint | Constraint[]

Specifies a filter or an array of filters, each of the form { <operator> : [<expression>...] }. Note that filters can also be specified in-line inside a Subject.

see

examples https://github.com/gsvarovsky/json-rql/search?l=JSON&q=filter&type=Code

Optional @graph

@graph: Subject | Subject[]

Specifies a Subject or an array of Subjects to match.

see

examples https://github.com/gsvarovsky/json-rql/search?l=JSON&q=graph&type=Code

Optional @optional

@optional: Group

Specifies a Group that may or may not match.

see

examples https://github.com/gsvarovsky/json-rql/search?l=JSON&q=optional&type=Code

Optional @union

@union: Pattern[]

Specifies an array of alternative patterns (Subject, Group or Query) to match.

see

examples https://github.com/gsvarovsky/json-rql/search?l=JSON&q=union&type=Code

Legend

  • Property

Generated using TypeDoc. Delivered by Vercel. json-rql - v0.6.0 Source code licensed MIT. Privacy policy