1.1.0-0 • Published 4 years ago
ghkv v1.1.0-0
ghkv
A key-value store for your CI/CD workflows. Backed by GitHub API.
API
const { GhkvDataStore } = require('ghkv')
const store = new GhkvDataStore(options)
options.accessToken
An access token used to access the GitHub APIoptions.owner
Owner of the repositoryoptions.repo
Repository nameoptions.branch
Branch used to store data, defaults to the default branch
const doc = store.doc<T>(key)
Retrieves a reference to the document by key.
doc.get(): Promise<T | undefined>
Retrieves the current document data.
doc.update(updater, options)
Updates the document.
updater: (data: T | undefined) => T
This function should return an updated document, given the original document. Note that it may be called more than once in case of a conflict due to concurrent updates.options.message
(Optional) The commit message.
doc.set(data, options)
Updates the document.
data
Data to set. In case of concurrent updates, last write wins.options.message
(Optional) The commit message.
1.1.0-0
4 years ago
1.0.0-eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee
4 years ago
1.0.0-eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee
4 years ago
1.0.0-eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee
4 years ago
1.0.0-eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee
4 years ago