tonic-iodeprecated

JavaScript library used to ease data exchange from a remote server with cache capability for Image, JSON, Text and binary data.

Usage no npm install needed!

<script type="module">
  import tonicIo from 'https://cdn.skypack.dev/tonic-io';
</script>

README

Tonic.io

Build Status Dependency Status semantic-release npm-download

Images

Tonic.io lets you download and cache images for faster usage inside your Web content.

Raw Binary

Tonic.io lets you download binary files and access their content without unnecessary conversion.

Text/JSON

Tonic.io handles common data formats. No need to have yet another library for managing complex and simple remote resources.

Query Data Model

Fetching various data could be driven by a query or a set of parameters. The QueryDataModel let you define multiple data entry that could easily be fetch each time the set of parameters that compose that query change.

Geometry Data Model

Similar to the QueryDataModel, the Geometry data model let you load all the required pieces of data that are need to build up a scene. That class abstract the access of the data and notify you when all the pieces of the scene are available.

Girder client

Tonic.io provides a composable girder client for any action you may need when having a [https://github.com/kitware/girder](Girder backend server).

Documentation

See the documentation for a getting started guide, advanced documentation, and API descriptions.

Development

The tonic suite of components can be develop independently of each other or treated as a whole.

When fetched individually, all the common build tools will be installed locally automatically either at post-install or when you build the library.

$ git clone https://github.com/kitware/tonic-io.git
$ cd tonic-io
$ npm install
$ npm run build

Otherwise you can get the full Tonic suite with the following set of commands:

$ git clone https://github.com/kitware/tonic.git
$ cd tonic
$ npm install
$ cd tonic-components/tonic-io
$ npm run build

Licensing

tonic-io is licensed under BSD Clause 3.

Getting Involved

Fork our repository and do great things. At Kitware, we've been contributing to open-source software for 15 years and counting, and want to make tonic-io useful to as many people as possible.