@comunica/mediator-number

A mediator for a single mediation number value

Usage no npm install needed!

<script type="module">
  import comunicaMediatorNumber from 'https://cdn.skypack.dev/@comunica/mediator-number';
</script>

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/^2.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.