{"id":21662806,"url":"https://github.com/higlass/higlass-register","last_synced_at":"2025-04-11T23:42:36.777Z","repository":{"id":57264212,"uuid":"129458045","full_name":"higlass/higlass-register","owner":"higlass","description":"Helper tool to register pluggable tracks","archived":false,"fork":false,"pushed_at":"2023-04-24T00:43:05.000Z","size":699,"stargazers_count":1,"open_issues_count":9,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-25T19:39:21.579Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/higlass.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-04-13T22:04:32.000Z","updated_at":"2021-09-12T13:59:30.000Z","dependencies_parsed_at":"2024-06-19T05:29:33.225Z","dependency_job_id":"625f8467-1bf0-44ea-af23-8999a0e5da10","html_url":"https://github.com/higlass/higlass-register","commit_stats":{"total_commits":29,"total_committers":3,"mean_commits":9.666666666666666,"dds":0.5517241379310345,"last_synced_commit":"0fe15442234ec961eb9ba2af2fb8731507b5d9e9"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/higlass%2Fhiglass-register","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/higlass%2Fhiglass-register/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/higlass%2Fhiglass-register/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/higlass%2Fhiglass-register/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/higlass","download_url":"https://codeload.github.com/higlass/higlass-register/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248155000,"owners_count":21056542,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-25T10:18:09.405Z","updated_at":"2025-04-11T23:42:36.742Z","avatar_url":"https://github.com/higlass.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HiGlass Register\n\n\u003e Pluggable Track Register Tool for HiGlass\n\n[![HiGlass](https://img.shields.io/badge/higlass-👍-red.svg?colorB=0f5d92)](http://higlass.io)\n[![Build Status](https://img.shields.io/travis/higlass/higlass-register/master.svg?colorB=0f5d92)](https://travis-ci.org/higlass/higlass-register)\n\nIf you develop pluggable tracks for HiGlass please use this simple tool to _register_ your tracks.\n\n_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._\n\n## Installation\n\n```\nnpm install --save-dev higlass-register\n```\n\n## Usage: plugin tracks\n\nTo register your track as a plugin\n\n```javascript\nimport register from 'higlass-register';\n\nimport MyFancyNewHiGlassTrack from './MyFancyNewHiGlassTrack';\n\nregister(\n  {\n    track: MyFancyNewHiGlassTrack,\n    config: MyFancyNewHiGlassTrack.config,\n  },\n  {\n    // Set to `true` if you want to override previously registered track that\n    // define the same track type.\n    force: false \n  }\n);\n```\n\nTake a look at [HiGlass GeoJSON Track](https://github.com/flekschas/higlass-geojson) for how to write a pluggable track.\n\n## Usage: plugin data fetchers\n\nTo register your data fetcher as a plugin\n\n```javascript\nimport register from 'higlass-register';\n\nimport MyFancyNewHiGlassDataFetcher from './MyFancyNewHiGlassDataFetcher';\n\nregister(\n  {\n    dataFetcher: MyFancyNewHiGlassDataFetcher,\n    config: MyFancyNewHiGlassDataFetcher.config,\n  },\n  {\n    // The default pluginType is 'track', so specify 'dataFetcher' here.\n    pluginType: 'dataFetcher',\n    // Set to `true` if you want to override previously registered data fetcher that\n    // define the same data fetcher type.\n    force: false \n  }\n);\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhiglass%2Fhiglass-register","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhiglass%2Fhiglass-register","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhiglass%2Fhiglass-register/lists"}