@heroiclands/package-build 23.12.5 → 23.12.6

package/types/engine/reckoning-markers.d.mts

@@ -10,5 +10,36 @@ export function resolveReckoningMarkers(index: any, daysPerYear: any): {
         file?: any;
     }[];
 };
-/** Read the world's year length and resolve every calendar era in one corpus. */
+/**
+ * The key a note's resolved calendar is filed under: its type and shortcode.
+ *
+ * @param {object|undefined} fm - A note's frontmatter or record.
+ * @returns {string|undefined} The key.
+ */
+export function noteCalendarKey(fm: object | undefined): string | undefined;
+/**
+ * A record's `resolvedCalendar` as its canonical Address string: an Address
+ * tuple, as a record in memory carries it, or the string an encoded record
+ * carries.
+ *
+ * @param {unknown} value - The value.
+ * @returns {string|undefined} The Address, or `undefined` for none.
+ */
+export function calendarAddress(value: unknown): string | undefined;
+/**
+ * Each note's resolved calendar, by {@link noteCalendarKey}, from the
+ * `resolvedCalendar` the content index writes on a record.
+ *
+ * @param {Iterable<object>|undefined} notes - Index records, or
+ *   `{ fm, resolvedCalendar }` entries.
+ * @returns {Map<string, string>} Note key to the calendar's canonical Address.
+ */
+export function noteCalendarMap(notes: Iterable<object> | undefined): Map<string, string>;
+/**
+ * Read the world's year length and resolve every calendar era in one corpus.
+ *
+ * The context also carries `noteCalendars`, each note's resolved calendar by
+ * note, read from the `resolvedCalendar` the content index writes on a record;
+ * {@link module:engine/note-calendars.noteCalendar} reads it.
+ */
 export function reckoningContext(index: any): any;