pipe-web-client

Web client for importing visualizations and analysis from Pipe

Usage no npm install needed!

<script type="module">
  import pipeWebClient from 'https://cdn.skypack.dev/pipe-web-client';
</script>

README

Pipe web client

Build Status Coverage Status

Installation

npm install pipe-web-client --save

Usage

{compile-query} = (require \pipe-web-client) end-point: "pipe-api-server-url"

{execute, transformation-function, presentation-function} <- compile-query \your-query-id .then

# execute :: (Promise p) => Boolean -> Parameters -> p result
query-result <- execute false, {} .then

# transformation-function :: result -> Parameters -> result
transformed-result = transformation-function query-result, {}

# presentation-function :: DOMElement -> result -> Parameters -> DOM()
presentation-function view, transformed-result, {}

Plottables

Demo / Test bed

Development

  • run gulp
  • visit http://localhost:8001
  • for unit tests, run npm test
  • for code coverage, run gulp coverage