TypeScript

The promptodex package includes full TypeScript support out of the box.

Types

import {
  pod,
  fetchPrompt,
  renderPrompt,
  Variables,
  PromptResponse,
  FetchOptions,
  PodOptions,
} from "promptodex";

Variables

The type for variable objects passed to prompts:

const variables: Variables = {
  name: "Matt",
  count: 42,
  active: true,
};

PodOptions

Options for the pod() function:

interface PodOptions {
  apiKey?: string; // For private prompts
}

PromptResponse

The response from fetchPrompt():

interface PromptResponse {
  slug: string;
  content: string;
}

FetchOptions

Options for fetchPrompt():

interface FetchOptions {
  apiKey?: string; // For private prompts
}

Example

import { pod, Variables, PodOptions } from "promptodex";

const variables: Variables = {
  topic: "TypeScript",
  content: "Article text here...",
};

const options: PodOptions = {
  apiKey: "POD_live_XXXXXXX",
};

const prompt: string = await pod("summarize@1", variables, options);

Next Steps

• Private Prompts — Access private prompts in code
• SDK API Reference — Full API documentation