README.md

Status

(status)

Overview

Status of a recipe

Available Operations

• getRecipeStatus - Get the status of a recipe

getRecipeStatus

Get the status of a recipe

Example Usage

import { SpeakeasyRecipeBook } from "speakeasy-recipe-book";

const speakeasyRecipeBook = new SpeakeasyRecipeBook();

async function run() {
  const result = await speakeasyRecipeBook.status.getRecipeStatus({
    id: "<id>",
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyRecipeBookCore } from "speakeasy-recipe-book/core.js";
import { statusGetRecipeStatus } from "speakeasy-recipe-book/funcs/statusGetRecipeStatus.js";

// Use `SpeakeasyRecipeBookCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasyRecipeBook = new SpeakeasyRecipeBookCore();

async function run() {
  const res = await statusGetRecipeStatus(speakeasyRecipeBook, {
    id: "<id>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
request	custom_operations.GetRecipeStatusRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<custom_components.RecipeStatus>

Errors

Error Type	Status Code	Content Type
custom_errors.SDKError	4XX, 5XX	*/*