Skip to content

API Reference

Complete API documentation is available in the README.

Core Modules

Validation - validateEnv(), validateCustomEnv(), safeValidateEnv()

Schemas - githubActionsSchema, createEnvSchema()

Workflow Commands - setOutput(), addSummary(), debug(), error()

Context - getCurrentBranch(), getRepoInfo(), isPullRequest()

Inputs - validateInputs(), getInput(), getBooleanInput()

See the GitHub repository for complete TypeScript type definitions and JSDoc documentation.

Released under the MIT License.