Library

cartographer

---

cartographer / Library

Interface: Library

Defined in: types/settings.ts:196

Library configuration—defines a single catalog or collection.

A library is a catalog of items (works, books, articles, etc.) all stored in a single directory and sharing a common schema. Users can have multiple libraries (e.g., “Pulp Fiction”, “Personal Library”, “Research Notes”).

Example

const library: Library = {
  id: "pulp-fiction",
  name: "Pulp Fiction",
  path: "pulp-fiction/works",
  schema: {...},
  createdAt: "2026-01-01T00:00:00Z"
};

Properties

id

id: string

Defined in: types/settings.ts:198

Unique identifier for this library (used in activeLibraryId)

---

name

name: string

Defined in: types/settings.ts:200

User-friendly display name (shown in library selector)

---

path

path: string

Defined in: types/settings.ts:202

Vault path where catalog items are stored (e.g., ‘pulp-fiction/works’, ‘my-library/books’)

---

schema

schema: CatalogSchema

Defined in: types/settings.ts:204

Schema definition for this library (fields, types, configuration)

---

createdAt

createdAt: string

Defined in: types/settings.ts:206

ISO 8601 timestamp when this library was created