Class NoteEntity

constructor

• new NoteEntity(client: RankedClient, data: Note): NoteEntity

  Instantiates a new NoteEntity.

  Parameters

  • client: RankedClient

    The active SDK client instance.

  • data: Note

    The raw note data from the API.

  Returns NoteEntity

content

createdAt

id

staffer

updatedAt

userId

delete

• delete(): Promise<void>

  Deletes this note.

  Returns Promise<void>

  A promise resolving when the note is deleted.

getUser

• getUser(): Promise<UserEntity>

  Fetches the user associated with this note.

  Returns Promise<UserEntity>

  A promise resolving to the UserEntity of the note's owner.

  Example

  const noteOwner = await note.getUser();
  console.log(noteOwner.ign); // 'andrew0w0'
  Copy

update

• update(dto: UpdateNoteDto): Promise<NoteEntity>

  Updates this note's settings.

  Parameters

  • dto: UpdateNoteDto

    The fields to update.

  Returns Promise<NoteEntity>

  A promise resolving to the updated NoteEntity.