Function defineFeed

defineFeed<
    TInput,
    TResponse,
    TItem,
    E,
    R,
    TDefaults extends Partial<TInput> = {},
>(
    config: FeedConfig<TInput, TResponse, TItem, E, R, TDefaults>,
): {
    (
        initial: string,
    ): Effect<
        {
            checkpoint: Effect<
                WithOptionalDefaults<TInput, TDefaults>,
                never,
                never,
            >;
            next: Effect<FeedPage<TResponse, TItem>, E, R>;
        },
        FeedCheckpointDecodeError,
    >;
    (
        initial: WithOptionalDefaults<TInput, TDefaults>,
    ): Effect<
        {
            checkpoint: Effect<
                WithOptionalDefaults<TInput, TDefaults>,
                never,
                never,
            >;
            next: Effect<FeedPage<TResponse, TItem>, E, R>;
        },
    >;
}
Defines a feed. The factory takes the first input, or a cursor feed.checkpoint returned earlier — as an object (owner decision, 2026-10-24: never JSON text). Anything else, text included, fails with FeedCheckpointDecodeError.
Type Parameters
- TInput
- TResponse
- TItem
- E
- R
- TDefaults extends Partial<TInput> = {}
Parameters
- config: FeedConfig<TInput, TResponse, TItem, E, R, TDefaults>
Returns {
    (
        initial: string,
    ): Effect<
        {
            checkpoint: Effect<
                WithOptionalDefaults<TInput, TDefaults>,
                never,
                never,
            >;
            next: Effect<FeedPage<TResponse, TItem>, E, R>;
        },
        FeedCheckpointDecodeError,
    >;
    (
        initial: WithOptionalDefaults<TInput, TDefaults>,
    ): Effect<
        {
            checkpoint: Effect<
                WithOptionalDefaults<TInput, TDefaults>,
                never,
                never,
            >;
            next: Effect<FeedPage<TResponse, TItem>, E, R>;
        },
    >;
}

Function defineFeed

Type Parameters

Parameters

Settings