interface Dump

Returned by every endpoint that answers dumps, and pushed to clients by the dump_created and dump_updated socket messages. A URL dump has url and richContent, a file dump the file… fields. A private dump reaches its poster only.

Properties

id: string
kind: "url" | "file"
title: string
slug: string

Names the dump in its page's path, dumpPath (shared/paths.ts) building it with ownerUsername. Made from the title on creation, it changes only when edited, and is unique among its poster's dumps.

optional
comment: string

The poster's note on the dump, in Markdown.

userId: string

The poster's current name, which the dump's path starts with.

optional
updatedAt: Date
optional
url: string
optional
fileName: string
optional
fileMime: string
optional
fileSize: number
voteCount: number

Deleted comments are not counted.

isPrivate: boolean
optional
thumbnailMime: string

Set when the poster uploaded a custom thumbnail.

optional
categoryIds: string[]