LogoPear Docs
ReferencesModules

Modules

Catalog of installable Pear modules—application, UI, common, developer, and integration libraries shipped as `pear-*` packages.

Modules

The Pear global API is minimal and not intended as a standard library. Application and integration libraries are supplied via installable modules prefixed with pear-.

Stability legend

Module lists call out a stability indicator. The four levels:

StabilityDescription
stableUnlikely to change or be removed in the foreseeable future.
experimentalNew, untested, or has known issues.
deprecatedBeing removed or replaced in the future.
unstableMay change or be removed without warning.

Application libraries

Pear modules related directly to the application environment.

ModuleDescriptionSystems    Stability
pear-crasherUncaught exceptions & uncaught rejections crash logger
stable
pear-messageSend inter-app pattern-matched object messages
stable
pear-messagesReceive object messages that match a given object pattern
stable
pear-pipeParent-app-connected pipe, the other end of pear-run pipe
stable
pear-runRun Pear child app by link. Returns a pipe to the child pipe
stable
pear-updatesReceive platform and application update notifications
stable
pear-user-dirsGet the path of user-specific directories
stable
pear-wakeupsReceive wakeup events, including link clicks external to app
stable

User interface libraries

Pear modules that supply User Interface runtime capabilities.

ModuleDescriptionSystems    Stability
pear-electronPear User-Interface Library for Electron
stable
pear-bridgeLocal HTTP bridge for pear-electron applications
stable

Common libraries

Pear modules for general usage, including applications per case.

ModuleDescriptionSystems    Stability
pear-dropDrop data, including application reset
stable
pear-dumpSynchronize files from link to dir peer-to-peer or from-disk
stable
pear-gracedownPear graceful closer. For use with pipe.autoexit = false
stable
pear-infoRead Pear project information by link
stable
pear-linkParser-Serializer for pear:// links. Includes alias resolution
stable
pear-opwaitPear operation stream promise wrapper
stable
pear-releaseSet application production release version length
stable
pear-seedSeed or reseed a Pear app drive by link
stable
pear-stageSynchronize from-disk to app drive peer-to-peer
stable
pear-stampInterleave locals into a template, sync and stream
stable

Developer libraries

Pear modules to assist with developing & debugging

ModuleDescriptionSystems    Stability
pear-inspectSecurely enable remote debugging protocol over Hyperswarm
stable
pear-hotmodsFor pear-electron UI apps. Frontend framework-agnostic live-reload
stable

Integration libraries

Pear modules for runtime integrations. Such as pear-electron.

ModuleDescriptionSystems    Stability
pear-appdriveRead-only Hyperdrive API subset interface for application drives
stable
pear-aliasesList of aliases for pear://<alias> links
stable
pear-apiglobal.Pear API class
stable
pear-changelogChangelog parsing and diffing
stable
pear-constantsShared Pear constants
stable
pear-cmdCommand parser & definitions
stable
pear-errorsShared Pear error types
stable
pear-gunkShared builtins, overrides & linker mappings
unstable
pear-ipcInterprocess Communication library
stable
pear-refIO handle reference counter & tracker
stable
pear-rtiRuntime Information state bootstrap for API building
stable
pear-stateShared state structure & capabilities
stable
pear-terminalTerminal User Interface library
stable
pear-trybootUsed with pear-ipc, tries to boot sidecar on connect failure
stable

See also

On this page