@wdprlib/parser
    Preparing search index...

    Interface ProcessWikitextDataProvider<TPage>

    interface ProcessWikitextDataProvider<TPage extends WikitextPageContext> {
        fetchInclude?: (
            pageRef: PageRef,
            context: ProcessWikitextCallbackContext<TPage>,
        ) => Promise<string | null>;
        fetchListPages?: (
            query: NormalizedListPagesQuery,
            requirement: ListPagesDataRequirement,
            context: ProcessWikitextCallbackContext<TPage>,
        ) => Promise<ListPagesExternalData | null | undefined>;
        fetchListUsers?: (
            requirement: ListUsersDataRequirement,
            context: ProcessWikitextCallbackContext<TPage>,
        ) => Promise<ListUsersExternalData | null | undefined>;
        fetchRatings?: (
            refs: readonly RatingRef[],
            context: ProcessWikitextCallbackContext<TPage>,
        ) => Promise<readonly RatingState[]>;
        fetchTagCloud?: (
            requirement: TagCloudDataRequirement,
            context: ProcessWikitextCallbackContext<TPage>,
        ) => Promise<TagCloudExternalData | null | undefined>;
    }

    Type Parameters

    • TPage extends WikitextPageContext
    Index

    Properties

    fetchInclude? fetchListPages? fetchListUsers? fetchRatings? fetchTagCloud?

    Properties

    fetchInclude?: (
        pageRef: PageRef,
        context: ProcessWikitextCallbackContext<TPage>,
    ) => Promise<string | null>
    fetchListPages?: (
        query: NormalizedListPagesQuery,
        requirement: ListPagesDataRequirement,
        context: ProcessWikitextCallbackContext<TPage>,
    ) => Promise<ListPagesExternalData | null | undefined>
    fetchListUsers?: (
        requirement: ListUsersDataRequirement,
        context: ProcessWikitextCallbackContext<TPage>,
    ) => Promise<ListUsersExternalData | null | undefined>
    fetchRatings?: (
        refs: readonly RatingRef[],
        context: ProcessWikitextCallbackContext<TPage>,
    ) => Promise<readonly RatingState[]>

    Read only authorized, registered ratings in context.page, including declarations from its includes. Keys match exactly. Omit no-rate and inaccessible references. Main category policy and custom policies are independent. Votes belong to page + ref. ListPages/ListUsers output cannot declare ratings, including its nested includes. The host owns registration, aggregation and invalidation when included declarations change.

    fetchTagCloud?: (
        requirement: TagCloudDataRequirement,
        context: ProcessWikitextCallbackContext<TPage>,
    ) => Promise<TagCloudExternalData | null | undefined>

    Settings

    Member Visibility

    On This Page

    Properties