{"id":16007250,"url":"https://github.com/armordarks/vanrose","last_synced_at":"2026-03-01T02:33:04.265Z","repository":{"id":57390756,"uuid":"97242973","full_name":"ArmorDarks/Vanrose","owner":"ArmorDarks","description":"Supplementary tool for Vandoc","archived":false,"fork":false,"pushed_at":"2017-07-17T22:24:40.000Z","size":2,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-08T12:48:06.905Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ArmorDarks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-07-14T14:34:53.000Z","updated_at":"2017-07-14T14:40:13.000Z","dependencies_parsed_at":"2022-09-01T16:03:22.019Z","dependency_job_id":null,"html_url":"https://github.com/ArmorDarks/Vanrose","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArmorDarks%2FVanrose","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArmorDarks%2FVanrose/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArmorDarks%2FVanrose/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArmorDarks%2FVanrose/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ArmorDarks","download_url":"https://codeload.github.com/ArmorDarks/Vanrose/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240645433,"owners_count":19834417,"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-10-08T12:02:25.672Z","updated_at":"2026-03-01T02:33:04.182Z","avatar_url":"https://github.com/ArmorDarks.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"Vanrose\n------\n\n\u003e Van Helsing used to put Wild Roses on coffins to immobilize vampires. Now, the times have changed. Put Vanrose on hunted docs objects, to empower them.\n\nSupplementary tool for [Vandoc](https://github.com/ArmorDarks/Vandoc).\n\n* Accepts Vandoc result object\n* Provides handy methods to work with object\n\n_So far it is only initial draft._\n\n#### Methods\n\n```js\nconst v = vanrose(vandocData, { cwd: '/source' })\n```\n\n* `v.cwd()` — returns current working directory\n* `v.filterLanguage('languageName')` — returns entries only for specified language.\n* `v.toc()` — returns Object with Table of Content based on inner values with appropriate links for each entry, taking into account `cwd`.\n* `v.href(':module/path')` — creates proper `href` from `Namepath` which can be used for anchors.\n* `v.module('myModule/path')` — returns associated with specified module entries\n* `v.rejectPrivate()` — filters out entries with `private: true`\n* `v.rejectIgnored()` — filters out entries with `ignored: true`\n* `v.entry('namepath')` — returns entry\n* `v.entry('namepath').signature()` — returns entry signature (if there are any) with all params and Flow-style type annotation: `input: number, name?: string`\n\n   This function can be extended later to return signature with different annotation styles.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farmordarks%2Fvanrose","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farmordarks%2Fvanrose","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farmordarks%2Fvanrose/lists"}