Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents some graph content. This is like a JSON-LD object with the following non-compliances:

  1. Object keys and values can be variables like "?variable".
  2. Values can be in-line filters, of the form { <operator> : <expression> }. The operator is acting as an infix, and in this case the expression represents only the RHS. The object may specify a variable to be matched against the filter by including an @id key as well as the operator, like this: { '@id' : "?variable", <operator> : <expression> }.

Hierarchy

Indexable

[key: string]: SubjectPropertyObject | Context | undefined

Specifies a graph edge, that is, a mapping from the @id of this JSON object to one or more values, which may also express constraints.

see

https://json-ld.org/spec/latest/json-ld/#embedding

Index

Properties

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 @id

@id: Iri | Variable | InlineFilter

Used to uniquely identify things that are being described in the document with IRIs or blank node identifiers.

Optional @type

@type: Iri | Variable | Iri[] | Variable[] | InlineFilter

Used to set the data type of a node or typed value.

see

https://json-ld.org/spec/latest/json-ld/#specifying-the-type

Legend

  • Property

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