# Overview

> API reference generated from the pipedog TypeScript sources.

Source: https://polvallverdu.github.io/pipedog/docs/api/



The tables in this section are generated at build time with
[fumadocs-typescript](https://fumadocs.dev/docs/ui/typescript) (`AutoTypeTable`), straight from
`packages/core/src` and `packages/asyncio/src`, so they always match the code. Descriptions come
from the JSDoc in the sources, which keeps upstream's docstrings.

<Cards>
  <Card title="Frames" href="/docs/api/frames">
    `Frame`, the three base categories, and common frame options.
  </Card>

  <Card title="FrameProcessor" href="/docs/api/frame-processor">
    Processor options, setup, and the `FrameProcessor` class.
  </Card>

  <Card title="PipelineWorker & WorkerRunner" href="/docs/api/pipeline-worker">
    `PipelineParams`, worker options, runner options, `runTest`.
  </Card>

  <Card title="@pipedog/asyncio" href="/docs/api/asyncio">
    `Task`, `createTask`, `waitFor`, `Queue`, `Event` and friends.
  </Card>
</Cards>

Click a row's type to expand its full TypeScript type and documentation.