Skip to main content
Version: 4.0 (RC)

Public API surface maps

Each *.api.md file here is a generated map of the public, type-level interface of one @crawlee/* package. Being in a report is the backwards-compatibility promise; being absent means no promise, not that the symbol is unreachable. See the Public API guide for what that means for users.

  • Untagged members are promised. The codebase does not use explicit @public tags.
  • @internal (and the legacy @ignore) members are trimmed from the report but stay exported and present in the .d.ts. Use #private / private when something should be unreachable, @internal when it should be reachable but unsupported.
  • @private is inert: it does not remove anything from the report.

The reports are generated by apify/api-extractor-report; its README explains how they are produced and what it fixes up in API Extractor's output. Regenerating and CI checks are covered in CONTRIBUTING.md.

Reading a report​

  • Forgotten exports are types the public API references but the entry point does not export. They appear without export under a // Not exported by the entry point banner: their shape is promised, their name is not importable. Export one deliberately if it should be.
  • crawlee.api.md is nearly empty on purpose. The meta-package only has export * lines, and everything they re-export is inventoried in the constituent package's report.
  • @crawlee/cli and @crawlee/templates are excluded: they are tooling, not an importable API.