Class PeriodicNotes

constructor

• new PeriodicNotes(
      config:
          | {
              dateFormat: string;
              dateOptions: DateTimeOptions;
              folder: string;
              intervalDuration: Duration<true>;
              intervalOffset: Duration<true>;
          }
          | {
              dateFormat: string;
              dateOptions?: DateTimeOptions;
              folder: string;
              intervalDuration: DurationLike;
              intervalOffset?: DurationLike;
          },
  ): PeriodicNotes

  Parameters

  • config:
        | {
            dateFormat: string;
            dateOptions: DateTimeOptions;
            folder: string;
            intervalDuration: Duration<true>;
            intervalOffset: Duration<true>;
        }
        | {
            dateFormat: string;
            dateOptions?: DateTimeOptions;
            folder: string;
            intervalDuration: DurationLike;
            intervalOffset?: DurationLike;
        }
    • {
          dateFormat: string;
          dateOptions: DateTimeOptions;
          folder: string;
          intervalDuration: Duration<true>;
          intervalOffset: Duration<true>;
      }

      • dateFormat: string

        The format used to parse a DateTime from file names. Must work for both parsing and formatting.

      • dateOptions: DateTimeOptions

        Luxon options used when parsing DateTimes from file names.

      • folder: string

        The folder containing all of the notes. TODO: Support files organized into different folders.

      • intervalDuration: Duration<true>

        The Duration of each file's corresponding Interval. Daily notes, for example, should use a duration of { days: 1 }.

      • intervalOffset: Duration<true>

        Offset between the file's parsed date and the corresponding Interval's start date. May be negative. Sprint notes, for example, can use ISO weeks for dateFormat and intervalOffset for their weekday.
    • {
          dateFormat: string;
          dateOptions?: DateTimeOptions;
          folder: string;
          intervalDuration: DurationLike;
          intervalOffset?: DurationLike;
      }

      • dateFormat: string

        The format used to parse a DateTime from file names. Must work for both parsing and formatting.

      • OptionaldateOptions?: DateTimeOptions

        Luxon options used when parsing DateTimes from file names.

      • folder: string

        The folder containing all of the notes. TODO: Support files organized into different folders.

      • intervalDuration: DurationLike

        The Duration of each file's corresponding Interval. Daily notes, for example, should use a duration of { days: 1 }.

      • OptionalintervalOffset?: DurationLike

        Offset between the file's parsed date and the corresponding Interval's start date. May be negative. Sprint notes, for example, can use ISO weeks for dateFormat and intervalOffset for their weekday.

  Returns PeriodicNotes

ReadonlydateFormat

ReadonlydateOptions

Readonlyfolder

ReadonlyintervalDuration

ReadonlyintervalOffset

getIntervalOf

• getIntervalOf(filePath: string): Interval<true> | Interval<false>

  Used to accurately enable date-based queries on collections and to look up "neighboring" files.

  Parameters

  • filePath: string

    the path to check.

  Returns Interval<true> | Interval<false>

  the Interval corresponding to the file, otherwise an invalid interval.