JSPM

  • Created
  • Published
  • Downloads 13076
  • Score
    100M100P100Q148424F
  • License MIT

A mediator for a single mediation number value

Package Exports

  • @comunica/mediator-number
  • @comunica/mediator-number/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@comunica/mediator-number) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Comunica Number Mediator

npm version

A mediator that can mediate over a single number field. It can either choose the actor with the maximum or with the minimum value.

This module is part of the Comunica framework, and should only be used by developers that want to build their own query engine.

Click here if you just want to query with Comunica.

Install

$ yarn add @comunica/mediator-number

Configure

After installing, this mediator can be instantiated as follows:

{
  "@context": [
    ...
    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/mediator-number/^4.0.0/components/context.jsonld"
  ],
  "actors": [
    ...
    {
      "@type": "SomeActor",
      "someMediator": {
        "@id": "#mediatorQueryOperation",
        "@type": "MediatorNumber",
        "field": "httpRequests",
        "type": "min",
        "ignoreErrors": true,
        "bus": { "@id": "ActorQueryOperation:_default_bus" }
      }
    }
  ]
}

Instead of MediatorNumberMin, MediatorNumberMax could also be used to resolve to the maximum value.

Config Parameters

  • bus: Identifier of the bus to mediate over.
  • field: The field name to mediate over.
  • type: The way how the index should be selected. For choosing the minimum value: 'min'. For choosing the maximum value: 'max'.
  • ignoreErrors: Optional flag to indicate if actors that throw test errors should be ignored, defaults to false.