jamespot-user-api
    Preparing search index...

    Class JWedocApi

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    network: Network

    Methods

    • Type Parameters

      • F extends "raw-little" | "raw-list" | "raw-view" = LIST

      Parameters

      • payload: { title: string; uriFolder?: string }
      • Optionaloptions: { format?: F; signal?: AbortSignal }

      Returns Promise<
          ApiWrapper<
              FormatArticles<F> & { _extend?: Pick<ExtendSchema, never> },
              BaseMessages,
          >,
      >

    • Type Parameters

      • F extends "raw-little" | "raw-list" | "raw-view" = LIST

      Parameters

      • payload: { uriFolder?: string }
      • Optionaloptions: { format?: "raw-little" | "raw-list" | "raw-view"; signal?: AbortSignal }

      Returns Promise<
          ApiWrapper<
              (FormatArticles<F> & { _extend?: Pick<ExtendSchema, never> })[],
              BaseMessages,
          >,
      >

    • Parameters

      • Optionaloptions: { signal?: AbortSignal }

      Returns Promise<
          ApiWrapper<
              {
                  color: string;
                  description: string;
                  extension: string;
                  icon: string;
                  label: string;
              }[],
              BaseMessages,
          >,
      >

    • Type Parameters

      Parameters

      • payload: { limit?: number; page?: number; query?: string; uriFolder?: string }
      • Optionaloptions: { extensions?: E; format?: F; signal?: AbortSignal }

      Returns Promise<
          ApiWrapper<
              PagingResults<
                  | (FormatArticles<F> & { _extend?: Pick<ExtendSchema, never>; })
                  | FileReturn<F, E>,
              >,
              BaseMessages,
          >,
      >

    • Type Parameters

      Parameters

      • payload: { limit?: number; page?: number; query?: string }
      • Optionaloptions: { extensions?: E; format?: F; signal?: AbortSignal }

      Returns Promise<
          ApiWrapper<
              PagingResults<
                  | (FormatArticles<F> & { _extend?: Pick<ExtendSchema, never>; })
                  | FileReturn<F, E>,
              >,
              BaseMessages,
          >,
      >