{"id":25622669,"url":"https://github.com/unfoldingword/bible-reference-range","last_synced_at":"2025-02-22T10:20:10.249Z","repository":{"id":47268722,"uuid":"515978328","full_name":"unfoldingWord/bible-reference-range","owner":"unfoldingWord","description":"Library for Parsing Bible References","archived":false,"fork":false,"pushed_at":"2023-12-07T19:15:38.000Z","size":167,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-04-13T16:08:17.344Z","etag":null,"topics":["scripture-open-components"],"latest_commit_sha":null,"homepage":"","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/unfoldingWord.png","metadata":{"files":{"readme":"README.md","changelog":null,"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}},"created_at":"2022-07-20T12:44:40.000Z","updated_at":"2023-07-19T04:20:40.000Z","dependencies_parsed_at":"2023-02-12T04:46:15.680Z","dependency_job_id":null,"html_url":"https://github.com/unfoldingWord/bible-reference-range","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfoldingWord%2Fbible-reference-range","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfoldingWord%2Fbible-reference-range/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfoldingWord%2Fbible-reference-range/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfoldingWord%2Fbible-reference-range/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/unfoldingWord","download_url":"https://codeload.github.com/unfoldingWord/bible-reference-range/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240157924,"owners_count":19757056,"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":["scripture-open-components"],"created_at":"2025-02-22T10:20:09.598Z","updated_at":"2025-02-22T10:20:10.234Z","avatar_url":"https://github.com/unfoldingWord.png","language":"JavaScript","readme":"# bible-reference-range\n\n[![CI Status](https://github.com/unfoldingWord/bible-reference-range/workflows/CI/badge.svg)](https://github.com/unfoldingWord/bible-reference-range/actions)\n[![Current Verison](https://img.shields.io/github/tag/unfoldingWord/bible-reference-range.svg)](https://github.com/unfoldingWord/bible-reference-range/tags)\n[![View this project on NPM](https://img.shields.io/npm/v/bible-reference-range)](https://www.npmjs.com/package/bible-reference-range)\n[![Coverage Status](https://coveralls.io/repos/github/unfoldingWord/bible-reference-range/badge.svg?branch=main)](https://coveralls.io/github/unfoldingWord/bible-reference-range?branch=main)\n\nA Library for handling bible reference ranges.\n\n### API\n\nThese are the exposed end-points\n\n- parseReferenceToList\n  - Takes a reference and splits into individual verses or verse spans. Can handle reference in format such as: “2:4-5”, “2:3a”, “2-3b-4a”, “2:7,12”, “7:11-8:2”, \"6:15-16;7:2\". It returns a list of {chapter, verse}. Or in the case of a verse range it returns {chapter, verse, endChapter, endVerse}.\n- getVerses\n  - finds all verses from a bible contained in ref, returning an array of {chapter, verse, verseData}\n- cleanupReference\n  - takes a reference and splits into individual verses or verse spans for cleanup. Then recombines the cleaned up references to a string. Primarily it removes extra characters following the verse number (as in the case of `2:4b-5a`) to make it easier to iterate through the verses.\n- referenceHelpers\n  - contains all the lower level methods to allow external use.\n- doesReferenceContain\n  - Takes two references and determines if a reference is contained within another reference.\n\n### INSTALL\n\n- npm users : `nmp i`\n- yarn users : `yarn`\n\n### USING\n\n- In your code add import:\n  `import { parseReferenceToList, cleanupReference } from 'bible-reference-range';`\n- or to use all the exports do:\n  `import { referenceHelpers } from 'bible-reference-range';`\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funfoldingword%2Fbible-reference-range","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funfoldingword%2Fbible-reference-range","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funfoldingword%2Fbible-reference-range/lists"}