skier. v1.0.0

API Reference

Skier's programmatic surface — the types you import and the contract you implement when you write skier.tasks.mjs or author a custom task. Everything documented here is exported from the package root:

import {
  // built-in task factories
  prepareOutputTask,
  generateItemsTask,
  // …and their config + output types
} from 'skier';

import type {
  TaskDef,
  TaskContext,
  Logger,
  SkierItem,
  SkierGlobals,
} from 'skier';

Every code block in this section is transcluded from the real source at build time (via @include), so the signatures here are always exactly what the package ships — they cannot drift.

What's here

Page Covers
Task Contract TaskDef, TaskContext, Logger — the shape every task implements and the config-in / globals-out contract run() follows. This is the custom-task authoring API.
Core Types SkierItem and SkierGlobals (the data that flows through a pipeline), plus the structured data built-in tasks produce: NavData, PaginationMeta, SearchIndex.
Config Interfaces The exported *Config type for every built-in task, in one place, each linking to its full Task Reference page.

How the pieces fit

flowchart LR
    Config[*Config] -->|passed to| Factory[task factory]
    Factory -->|returns| TaskDef
    TaskDef -->|run config, ctx| Output
    Output -->|merged into| Globals[SkierGlobals]
    Globals -->|read by| Next[next task's run]

A task factory (e.g. generateItemsTask) takes a *Config object and returns a TaskDef. Skier runs each TaskDef's run() in order, passing the config and a shared TaskContext; whatever run() returns is merged into SkierGlobals for later tasks and templates to read.

  • Custom Tasks — the how-to guide for writing tasks (this section is the reference for the types that guide uses).
  • Task Reference — per-task usage, options, and examples for every built-in.
  • Architecture — the end-to-end pipeline model.