• Preparing search index...
  • The search index is not available
@immediately-run/sdk
  • @immediately-run/sdk
  • contribute

Function contribute

  • contribute(
        opts: ContributeOptions,
    ): AsyncGenerator<ContributionEvent, ContributionResult, void>

    Save the current working tree, streaming each stage.

    for await (const ev of contribute({ commitMessage: 'Edit post' })) {
    if (ev.stage === 'done') console.log(ev.prUrl);
    }

    Yields ContributionEvents and returns a ContributionResult. Throws a StreamError (.code) if the host rejects the request — notably forbidden when a contribute:any app asks for mode: 'direct' (T11).

    Parameters

    • opts: ContributeOptions

    Returns AsyncGenerator<ContributionEvent, ContributionResult, void>

    • Defined in src/contribute.ts:73

Settings

Member Visibility
@immediately-run/sdk
  • Loading...

Generated using TypeDoc