AGPL-3.0-or-later · forever.

{"id":"reference/methods","slug":"methods","section":"reference","label":"Method index","summary":"Every LocalNika, jobs and workflows method at a glance.","status":"mixed","docsPath":"https://docs.nika.sh/sdk/reference/methods","eyebrow":"reference · method index","title":"Scan the whole client.","description":"A compact index of every local method and every preview jobs, workflows, health and webhook method.","promise":"The index names the owner and return shape so application code can choose the smallest surface that solves its job.","facts":[{"label":"local owner","value":"LocalNika"},{"label":"remote owners","value":"Nika · jobs · workflows"},{"label":"event form","value":"AsyncIterable"},{"label":"source","value":"Apache-2.0"}],"sections":[{"label":"01 · local live","title":"LocalNika methods.","body":"These methods drive the released binary and preserve its machine contracts.","ascii":"version()                  Promise<string>\ncheck(file, options?)      Promise<LocalCheckReport>\ndryRunPlan(file)           Promise<LocalPlan>\nrun(file, options?)        RunHandle\nrunToEnd(file, options?)   Promise<LocalRunOutcome>\ntest(file, { update? })    Promise<GoldenVerdict>\ntraceVerify(path?)         Promise<TraceVerdict>"},{"label":"02 · remote preview","title":"Jobs and workflows.","body":"The root client groups operations by resource. The compatible service is not shipped by the reference engine today.","ascii":"jobs.submit · status · cancel · run · stream\njobs.artifacts · artifact · artifactJson\njobs.artifactBinary · artifactStream · runAndCollect\n\nworkflows.list · listPage · reload · source"},{"label":"03 · system preview","title":"Health and signatures.","body":"health probes the service without authorization. verifyWebhook is a static Web Crypto utility and can be tested without a service.","code":"await nika.health()\nawait Nika.verifyWebhook(body, signature, secret)","language":"typescript","filename":"system.ts"}],"related":[{"label":"Configuration","to":"/sdk/reference/configuration"},{"label":"Type index","to":"/sdk/reference/types"},{"label":"SDK source","to":"https://github.com/supernovae-st/nika-client","external":true},{"label":"Full docs reference","to":"https://docs.nika.sh/sdk/reference/methods","external":true}]}

reference · method index

Scan the whole client.

A compact index of every local method and every preview jobs, workflows, health and webhook method.

The index names the owner and return shape so application code can choose the smallest surface that solves its job.

LocalNika methods.

These methods drive the released binary and preserve its machine contracts.

version()                  Promise<string>
check(file, options?)      Promise<LocalCheckReport>
dryRunPlan(file)           Promise<LocalPlan>
run(file, options?)        RunHandle
runToEnd(file, options?)   Promise<LocalRunOutcome>
test(file, { update? })    Promise<GoldenVerdict>
traceVerify(path?)         Promise<TraceVerdict>

Jobs and workflows.

The root client groups operations by resource. The compatible service is not shipped by the reference engine today.

jobs.submit · status · cancel · run · stream
jobs.artifacts · artifact · artifactJson
jobs.artifactBinary · artifactStream · runAndCollect

workflows.list · listPage · reload · source

Health and signatures.

health probes the service without authorization. verifyWebhook is a static Web Crypto utility and can be tested without a service.

await nika.health()
await Nika.verifyWebhook(body, signature, secret)