Molecule.dev

← All @molecule/* packages · App templates

@molecule/api-git-provider-github

Provider bond · git-provider · API (Node) · v1.0.3 · Apache-2.0

Git hosting provider for GitHub (github.com) — OAuth endpoints, token auth shape, repository listing and lookup.

npm install @molecule/api-git-provider-github

npm · Source on GitHub · Implements @molecule/api-git-provider

How it works

@molecule/api-git-provider-github is a provider bond on the API (Node) side: it implements the git-provider core interface (@molecule/api-git-provider) with a concrete vendor or library behind it.

Your code calls the core; you wire this provider once at startup. Swapping vendors later is one line in that wiring, not a rewrite.

import { registerGitProvider } from '@molecule/api-git-provider'
import { provider } from '@molecule/api-git-provider-github'

registerGitProvider(provider)

Works with: @molecule/api-git-provider, @molecule/api-http

Reference

Auto-generated, AI-first package reference for the molecule.dev ecosystem. It is written to be read by coding agents as much as by people, and is generated from this package's source — edit src/index.ts JSDoc, not this file.

@molecule/api-git-provider-github — a @molecule/api-git-provider bond.

Register it with registerGitProvider(provider) in setupBonds(); the app then never names this host. See the core package for the interface and for why basicAuthUsername may be null.

Quick Start

import { registerGitProvider } from '@molecule/api-git-provider'
import { provider } from '@molecule/api-git-provider-github'

registerGitProvider(provider)

Type

provider

Installation

npm install @molecule/api-git-provider-github @molecule/api-git-provider @molecule/api-http

API

Constants

provider

The GitHub provider.

const provider: GitProvider

Core Interface

Implements @molecule/api-git-provider interface.

Bond Wiring

Setup function to register this provider with the core interface:

import { registerGitProvider } from '@molecule/api-git-provider'
import { provider } from '@molecule/api-git-provider-github'

export function setupGitProviderGithub(): void {
  registerGitProvider(provider)
}

Injection Notes

Requirements

Peer dependencies:

  • @molecule/api-git-provider ^1.0.2
  • @molecule/api-http ^1.0.1

Runtime Dependencies

  • @molecule/api-git-provider
  • @molecule/api-http