Skip to main content

Functions

Functions by entry point

The functions each of the package's three entry points exports.

Outline
  • Sections:
    • @fairgarden/monolith
    • @fairgarden/monolith/link
    • @fairgarden/monolith/eslint

Read more

withMonolith

Composes several Next apps into one.

Outline
  • Sections:
    • Parameters
      • nextConfig
      • apps
      • options
    • What it does
    • Throws
    • Notes

Read more

prefixPath

Moves a path into an app's mount point.

Outline
  • Sections:
    • What is left alone
    • apiViaPages
    • Notes

Read more

getRegisteredApps

The apps seen by the most recent withMonolith evaluation.

Outline
  • Sections:
    • Returns
    • Notes

Read more

withMonolithicPortability

Checks, from inside an app, that it could be mounted into a monolith.

Outline
  • Sections:
    • Options
    • What it reports
    • Notes

Read more

findPortabilityProblems

Everything about an app that would not survive being mounted, as a list.

Outline
  • Sections:
    • Parameters
    • Returns
    • Notes

Read more

A next/link that knows where its app is mounted.

Outline
  • Sections:
    • Why it is needed
    • Standalone
    • Notes

Read more

createHref

The imperative counterpart to createLink, for anywhere an app builds a path itself.

Outline
  • Sections:
    • Standalone
    • Notes

Read more

mountPrefix

Where an app is mounted, or '' when it is running on its own.

Outline
  • Sections:
    • How it works
    • Notes

Read more

prefixHref

Moves one href into a mount point.

Outline
  • Sections:
    • What is left alone
    • Object hrefs
    • Notes

Read more