Options
All
  • Public
  • Public/Protected
  • All
Menu

Module build/utils

Index

Interfaces

Functions

Functions

buildStaticPaths

  • buildStaticPaths(page: string, getStaticPaths: GetStaticPaths, locales?: string[], defaultLocale?: string): Promise<Omit<UnwrapPromise<ReturnType<GetStaticPaths>>, "paths"> & { encodedPaths: string[]; paths: string[] }>

  • Parameters

    • page: string
    • getStaticPaths: GetStaticPaths
    • Optional locales: string[]
    • Optional defaultLocale: string

    Returns Promise<Omit<UnwrapPromise<ReturnType<GetStaticPaths>>, "paths"> & { encodedPaths: string[]; paths: string[] }>

collectPages

  • collectPages(directory: string, pageExtensions: string[]): Promise<string[]>

  • Parameters

    • directory: string
    • pageExtensions: string[]

    Returns Promise<string[]>

detectConflictingPaths

  • detectConflictingPaths(combinedPages: string[], ssgPages: Set<string>, additionalSsgPaths: Map<string, string[]>): void

  • Parameters

    • combinedPages: string[]
    • ssgPages: Set<string>
    • additionalSsgPaths: Map<string, string[]>

    Returns void

difference

  • difference<T>(main: T[] | Set<T>, sub: T[] | Set<T>): T[]

  • Type parameters

    • T

    Parameters

    • main: T[] | Set<T>
    • sub: T[] | Set<T>

    Returns T[]

getCssFilePaths

  • Parameters

    Returns string[]

getJsPageSizeInKb

  • getJsPageSizeInKb(page: string, distPath: string, buildManifest: BuildManifest): Promise<[number, number]>

  • Parameters

    Returns Promise<[number, number]>

getNamedExports

  • getNamedExports(page: string, distDir: string, isLikeServerless: boolean, runtimeEnvConfig: any): Promise<string[]>

  • Parameters

    • page: string
    • distDir: string
    • isLikeServerless: boolean
    • runtimeEnvConfig: any

    Returns Promise<string[]>

hasCustomGetInitialProps

  • hasCustomGetInitialProps(page: string, distDir: string, isLikeServerless: boolean, runtimeEnvConfig: any, checkingApp: boolean): Promise<boolean>

  • Parameters

    • page: string
    • distDir: string
    • isLikeServerless: boolean
    • runtimeEnvConfig: any
    • checkingApp: boolean

    Returns Promise<boolean>

isPageStatic

  • isPageStatic(page: string, distDir: string, serverless: boolean, runtimeEnvConfig: any, locales?: string[], defaultLocale?: string, parentId?: any): Promise<{ encodedPrerenderRoutes?: string[]; hasServerProps?: boolean; hasStaticProps?: boolean; isAmpOnly?: boolean; isHybridAmp?: boolean; isNextImageImported?: boolean; isStatic?: boolean; prerenderFallback?: boolean | "blocking"; prerenderRoutes?: string[] }>

  • Parameters

    • page: string
    • distDir: string
    • serverless: boolean
    • runtimeEnvConfig: any
    • Optional locales: string[]
    • Optional defaultLocale: string
    • Optional parentId: any

    Returns Promise<{ encodedPrerenderRoutes?: string[]; hasServerProps?: boolean; hasStaticProps?: boolean; isAmpOnly?: boolean; isHybridAmp?: boolean; isNextImageImported?: boolean; isStatic?: boolean; prerenderFallback?: boolean | "blocking"; prerenderRoutes?: string[] }>

printCustomRoutes

  • printCustomRoutes(__namedParameters: CustomRoutes): void

  • Parameters

    • __namedParameters: CustomRoutes

    Returns void

printTreeView

  • printTreeView(list: readonly string[], pageInfos: Map<string, PageInfo>, serverless: boolean, __namedParameters: { buildId: string; buildManifest: BuildManifest; distPath: string; pageExtensions: string[]; pagesDir: string; useStatic404: boolean }): Promise<void>

  • Parameters

    • list: readonly string[]
    • pageInfos: Map<string, PageInfo>
    • serverless: boolean
    • __namedParameters: { buildId: string; buildManifest: BuildManifest; distPath: string; pageExtensions: string[]; pagesDir: string; useStatic404: boolean }
      • buildId: string
      • buildManifest: BuildManifest
      • distPath: string
      • pageExtensions: string[]
      • pagesDir: string
      • useStatic404: boolean

    Returns Promise<void>

Generated using TypeDoc