Skip to content

cheminfo/cheminfo-types

Repository files navigation

cheminfo-types

NPM version build status npm download

Types for cheminfo packages and cheminfo data schema.

Key principles:

  • One type should correspond to one React component
  • The schema should not be so complicated that it becomes unusable
  • Use @tjs-examples to give examples that will show in the JSON schema and documentation

Installation

$ npm i cheminfo-types

Usage

See example
import type { MeasurementXY } from 'cheminfo-types';

const measurements: MeasurementXY[] = [];
const xAxis = {
  label: 'time',
  units: 's',
  isDependent: false,
  data: [1, 2, 3],
};
const yAxis = {
  label: 'current',
  units: 'mA',
  isDependent: true,
  data: [0.1, 8, 13],
};
const firstMeasurement: MeasurementXY = {
  title: 'Current Monitoring',
  variables: { x: xAxis, y: yAxis },
};
measurements.push(firstMeasurement);

License

MIT