Skip to content

Commit

Permalink
unrelated: add doc link imports for RawUsernotes
Browse files Browse the repository at this point in the history
  • Loading branch information
eritbh committed Dec 19, 2023
1 parent 3233cea commit 884c45b
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions src/types/RawUsernotes.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
// type imports for doc links
import type {
LATEST_KNOWN_USERNOTES_SCHEMA,
migrateUsernotesToLatestSchema,
} from '../helpers/usernotes';

/** Raw data for a single usernote */
export interface RawUsernotesNote {
/** Timestamp (seconds since epoch) */
Expand Down Expand Up @@ -39,10 +45,11 @@ export interface RawUsernotesConstants {
* Raw data stored as JSON on the `usernotes` wiki page.
*
* Note that while the library supports upgrading older schemas to the current
* one (via {@linkcode migrateUsernotesToLatestSchema}), this type only applies
* to schema version 6. If you are manually reading data from the wiki without
* passing it through the migration function, and you read a different `ver`
* value, this type will not describe that data.
* one (via {@linkcode migrateUsernotesToLatestSchema}), this type will only
* describe the latest known schema version. If you are manually reading data
* from the wiki without passing it through the migration function, and you read
* a `ver` value different than {@linkcode LATEST_KNOWN_USERNOTES_SCHEMA}, this
* type will not describe that data.
*/
export interface RawUsernotes {
/** The version number of the usernotes schema this data conforms to */
Expand Down

0 comments on commit 884c45b

Please sign in to comment.