# higlass-register

> HiGlass helper tool for registering pluggable tracks

Latest version **0.3.0** (published 2020-08-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install higlass-register
pnpm add higlass-register
yarn add higlass-register
bun add higlass-register
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2020-08-10 |
| First published | 2018-04-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 13.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Fritz Lekschas |
| Maintainers | flekschas |
| Keywords | HiGlass, Track, Register, Helper |

## Links

- npm: https://www.npmjs.com/package/higlass-register
- Repository: https://github.com/higlass/higlass-register
- Homepage: https://github.com/higlass/higlass-register#readme
- Issues: https://github.com/higlass/higlass-register/issues
- npm.io page: https://npm.io/package/higlass-register

## Alternatives

- [@sentry/react-native](https://npm.io/package/@sentry/react-native.md) — 2.6M weekly downloads
- [@ardatan/aggregate-error](https://npm.io/package/@ardatan/aggregate-error.md) — 708.1K weekly downloads
- [custom-error-generator](https://npm.io/package/custom-error-generator.md) — 2.0K weekly downloads
- [@technik-sde/prosemirror-recreate-transform](https://npm.io/package/@technik-sde/prosemirror-recreate-transform.md) — 1.5K weekly downloads
- [@suchipi/error-utils](https://npm.io/package/@suchipi/error-utils.md) — 78 weekly downloads

## Recent versions

- 0.3.0 (latest) — 2020-08-10
- 0.1.0 (beta) — 2018-04-14
- 0.2.0 — 2020-08-09
- 0.1.1 — 2020-08-09

## README

# HiGlass Register

> Pluggable Track Register Tool for HiGlass

[![HiGlass](https://img.shields.io/badge/higlass-👍-red.svg?colorB=0f5d92)](http://higlass.io)
[![Build Status](https://img.shields.io/travis/higlass/higlass-register/master.svg?colorB=0f5d92)](https://travis-ci.org/higlass/higlass-register)

If you develop pluggable tracks for HiGlass please use this simple tool to _register_ your tracks.

_Note, `higlass-register` is nothing more than an agreed way of exposing plugins to HiGlass. You could circumvent `higlass-register` but then you'll have to take of staying up to date with the plugin registration process yourself._

## Installation

```
npm install --save-dev higlass-register
```

## Usage: plugin tracks

To register your track as a plugin

```javascript
import register from 'higlass-register';

import MyFancyNewHiGlassTrack from './MyFancyNewHiGlassTrack';

register(
  {
    track: MyFancyNewHiGlassTrack,
    config: MyFancyNewHiGlassTrack.config,
  },
  {
    // Set to `true` if you want to override previously registered track that
    // define the same track type.
    force: false 
  }
);
```

Take a look at [HiGlass GeoJSON Track](https://github.com/flekschas/higlass-geojson) for how to write a pluggable track.

## Usage: plugin data fetchers

To register your data fetcher as a plugin

```javascript
import register from 'higlass-register';

import MyFancyNewHiGlassDataFetcher from './MyFancyNewHiGlassDataFetcher';

register(
  {
    dataFetcher: MyFancyNewHiGlassDataFetcher,
    config: MyFancyNewHiGlassDataFetcher.config,
  },
  {
    // The default pluginType is 'track', so specify 'dataFetcher' here.
    pluginType: 'dataFetcher',
    // Set to `true` if you want to override previously registered data fetcher that
    // define the same data fetcher type.
    force: false 
  }
);
```

---
_Source: https://npm.io/package/higlass-register · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
