Functions
- Functions by entry point - (Outline, Contents)
- withMonolith - (Outline, Contents)
- prefixPath - (Outline, Contents)
- getRegisteredApps - (Outline, Contents)
- withMonolithicPortability - (Outline, Contents)
- findPortabilityProblems - (Outline, Contents)
- createLink - (Outline, Contents)
- createHref - (Outline, Contents)
- mountPrefix - (Outline, Contents)
- prefixHref - (Outline, Contents)
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
withMonolith
Composes several Next apps into one.
Outline
- Sections:
- Parameters
nextConfigappsoptions
- What it does
- Throws
- Notes
- Parameters
prefixPath
Moves a path into an app's mount point.
Outline
- Sections:
- What is left alone
apiViaPages- Notes
getRegisteredApps
The apps seen by the most recent withMonolith evaluation.
Outline
- Sections:
- Returns
- Notes
withMonolithicPortability
Checks, from inside an app, that it could be mounted into a monolith.
Outline
- Sections:
- Options
- What it reports
- Notes
findPortabilityProblems
Everything about an app that would not survive being mounted, as a list.
Outline
- Sections:
- Parameters
- Returns
- Notes
createLink
A next/link that knows where its app is mounted.
Outline
- Sections:
- Why it is needed
- Standalone
- Notes
createHref
The imperative counterpart to createLink, for
anywhere an app builds a path itself.
Outline
- Sections:
- Standalone
- Notes
mountPrefix
Where an app is mounted, or '' when it is running on its own.
Outline
- Sections:
- How it works
- Notes
prefixHref
Moves one href into a mount point.
Outline
- Sections:
- What is left alone
- Object hrefs
- Notes