Type alias ArboretumClientT

Type declaration

• cachedData: (() => CachedDataT)

  • • (): CachedDataT

    • Returns CachedDataT

• homePage: ((localeCode, options?) => Either<string, ArboretumPageT>)

  • • (localeCode, options?): Either<string, ArboretumPageT>

    • Parameters

      • localeCode: string

      • Optional options: OptionsT

      Returns Either<string, ArboretumPageT>

• locales: (() => LocaleT[])

  • • (): LocaleT[]

    • Returns LocaleT[]

• pageById: ((localeCode, id, options?) => Either<string, ArboretumPageNodeT>)

  • • (localeCode, id, options?): Either<string, ArboretumPageNodeT>

    • Parameters

      • localeCode: string

      • id: string

      • Optional options: OptionsT

      Returns Either<string, ArboretumPageNodeT>

• pageByPath: ((path, options?) => Either<string, ArboretumPageNodeT>)

  • • (path, options?): Either<string, ArboretumPageNodeT>

    • Parameters

      • path: string

      • Optional options: OptionsT

      Returns Either<string, ArboretumPageNodeT>

• pages: ((options?) => Either<string, ArboretumPageNodeT[]>)

  • • (options?): Either<string, ArboretumPageNodeT[]>

    • Parameters

      • Optional options: OptionsT & {
            limit?: number;
            localeCode?: string;
            skip?: number;
        }

      Returns Either<string, ArboretumPageNodeT[]>

• pagesByIds: ((localeCode, ids, options?) => Either<string, ArboretumPageNodeT>[])

  • • (localeCode, ids, options?): Either<string, ArboretumPageNodeT>[]

    • Parameters

      • localeCode: string

      • ids: string[]

      • Optional options: OptionsT

      Returns Either<string, ArboretumPageNodeT>[]

• pagesByPaths: ((paths, options?) => Either<string, ArboretumPageNodeT>[])

  • • (paths, options?): Either<string, ArboretumPageNodeT>[]

    • Parameters

      • paths: string[]

      • Optional options: OptionsT

      Returns Either<string, ArboretumPageNodeT>[]

• pagesByTagId: ((localeCode, tagId, options?) => Either<string, ArboretumPageNodeT[]>)

  • • (localeCode, tagId, options?): Either<string, ArboretumPageNodeT[]>

    • Parameters

      • localeCode: string

      • tagId: string

      • Optional options: OptionsT

      Returns Either<string, ArboretumPageNodeT[]>

• regenerate: (() => Promise<{
      status: "OK";
      warnings?: string[];
  }>)

  • • (): Promise<{
          status: "OK";
          warnings?: string[];
      }>

    • Returns Promise<{
          status: "OK";
          warnings?: string[];
      }>

• search: ((phrase, localeCode?, limit?) => ArboretumPageNodeT[])

  • • (phrase, localeCode?, limit?): ArboretumPageNodeT[]

    • Parameters

      • phrase: string

      • Optional localeCode: string

      • Optional limit: number

      Returns ArboretumPageNodeT[]

• status: (() => {
      contentful: ArboretumClientOptionsT;
      lastUpdatedAt: string;
      localesCount: number;
      pagesCount: number;
      regenerationInProgress: boolean;
  })

  • • (): {
          contentful: ArboretumClientOptionsT;
          lastUpdatedAt: string;
          localesCount: number;
          pagesCount: number;
          regenerationInProgress: boolean;
      }

    • Returns {
          contentful: ArboretumClientOptionsT;
          lastUpdatedAt: string;
          localesCount: number;
          pagesCount: number;
          regenerationInProgress: boolean;
      }

      • contentful: ArboretumClientOptionsT

      • lastUpdatedAt: string

      • localesCount: number

      • pagesCount: number

      • regenerationInProgress: boolean