Rich runtime representation of a library.
Wraps LibraryJson with computed properties and provides the root
of the API documentation hierarchy: Library → modules → declarations
see also
module.svelte.ts for Module classdeclaration.svelte.ts for Declaration class
library_json
type LibraryJson
url_prefix
URL path prefix for multi-package documentation sites.
Prepended to /docs/api/ paths in Module.url_api and Declaration.url_api.
Default '' preserves single-package behavior.
type string
package_json
source_json
name
repo_name
repo_url
owner_name
homepage_url
logo_url
logo_alt
npm_url
changelog_url
published
org_url
Organization URL (e.g., 'https://github.com/ryanatkn').
modules
All modules as rich Module instances.
modules_sorted
All modules sorted alphabetically by path.
declarations
All declarations across all modules as a flat array.
declaration_map
Declaration lookup map by name. Provides O(1) lookup.
constructor
type new (library_json: LibraryJson, url_prefix?: string): Library
library_json
LibraryJsonurl_prefix
string''lookup_declaration
Look up a declaration by name.
type (name: string): Declaration | undefined
name
stringDeclaration | undefinedhas_declaration
Check if a declaration exists.
type (name: string): boolean
name
stringbooleanlookup_module
Look up a module by its canonical path.
type (path: string): Module | undefined
path
stringModule | undefinedsearch_declarations
Search declarations by query string with multi-term AND logic.
type (query: string): Declaration[]
query
stringDeclaration[]