Options
All
  • Public
  • Public/Protected
  • All
Menu

Used to express an ordered set of data. A List object is reified to a Subject (unlike in JSON-LD) and so it has an @id, which can be set by the user.

Note that this reification is only possible when using the @list keyword, and not if the active context specifies "@container": "@list" for a property, in which case the list itself is anonymous.

see

JSON-LD sets-and-lists

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.

Note that this reification is only possible when using the @list keyword, and not if the active context specifies "@container": "@list" for a property, in which case the list itself is anonymous.

see

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

Optional @id

@id: Iri | Variable | InlineFilter

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

@list

Optional @type

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

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

see

JSON-LD specifying-the-type

Legend

  • Property

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