{"id":19650933,"url":"https://github.com/taskworld/ghkv","last_synced_at":"2025-11-06T10:03:56.846Z","repository":{"id":44822661,"uuid":"266948285","full_name":"taskworld/ghkv","owner":"taskworld","description":"A key-value store for your CI/CD workflows, backed by GitHub API.","archived":false,"fork":false,"pushed_at":"2022-01-22T12:19:11.000Z","size":159,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-09T23:53:32.984Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/taskworld.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":"2020-05-26T04:58:40.000Z","updated_at":"2020-06-05T09:41:02.000Z","dependencies_parsed_at":"2022-09-16T04:11:19.002Z","dependency_job_id":null,"html_url":"https://github.com/taskworld/ghkv","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taskworld%2Fghkv","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taskworld%2Fghkv/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taskworld%2Fghkv/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taskworld%2Fghkv/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/taskworld","download_url":"https://codeload.github.com/taskworld/ghkv/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240959651,"owners_count":19885002,"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-11T15:04:03.441Z","updated_at":"2025-11-06T10:03:56.817Z","avatar_url":"https://github.com/taskworld.png","language":"TypeScript","readme":"# ghkv\n\nA key-value store for your CI/CD workflows. Backed by GitHub API.\n\n## API\n\n```js\nconst { GhkvDataStore } = require('ghkv')\n```\n\n### `const store = new GhkvDataStore(options)`\n\n- `options.accessToken` An access token used to access the GitHub API\n- `options.owner` Owner of the repository\n- `options.repo` Repository name\n- `options.branch` Branch used to store data, defaults to the default branch\n\n### `const doc = store.doc\u003cT\u003e(key)`\n\nRetrieves a reference to the document by key.\n\n### `doc.get(): Promise\u003cT | undefined\u003e`\n\nRetrieves the current document data.\n\n### `doc.update(updater, options)`\n\nUpdates the document.\n\n- `updater: (data: T | undefined) =\u003e T`\n  This function should return an updated document, given the original document.\n  Note that it may be called more than once in case of a conflict due to concurrent updates.\n- `options.message` (Optional) The commit message.\n\n### `doc.set(data, options)`\n\nUpdates the document.\n\n- `data` Data to set. In case of concurrent updates, last write wins.\n- `options.message` (Optional) The commit message.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaskworld%2Fghkv","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftaskworld%2Fghkv","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaskworld%2Fghkv/lists"}