@actor-types/fetch-actor-cli

A CLI tool to fetch actor schemas from Apify and generate TypeScript types and wrapper functions.

Installation

# Install globally
npm install -g @actor-types/fetch-actor-cli

# Or use npx
npx @actor-types/fetch-actor-cli

Usage

Generate Types for an Actor

fetch-actor generate <actor-id> <output-path>

Arguments

• <actor-id>: Actor ID (e.g., "john-doe/my-actor")
• <output-path>: Output file path (e.g., "src/types/myActor.ts")

Example

# Generate types for an actor
fetch-actor generate john-doe/my-actor src/types/myActor.ts

This will:

1. Fetch the actor information and input schema for "john-doe/my-actor"
2. Automatically use the actor's name from Apify
3. Generate a TypeScript interface (e.g., "MyActorInput")
4. Generate a wrapper function (e.g., "callMyActor")
5. Write the resulting TypeScript code to "src/types/myActor.ts"

Generated Code Example

export interface MyActorInput {
  url: string;
  maxPages?: number;
}

import { Actor, type CallOptions } from 'apify';

/**
 * Calls the actor "myActor" with the provided input.
 * @param input - Must conform to the MyActorInput type.
 * @param runOptions - Optional run options to pass to the actor.
 */
export async function callMyActor(input: MyActorInput, runOptions?: CallOptions): Promise<unknown> {
    return Actor.call('john-doe/my-actor', input, runOptions);
}

Development

# Clone the repository
git clone <repo-url>

# Install dependencies
cd actor-types-generator
npm install

# Build the CLI
npm run build

# Run locally
npm run dev