Skip to main content

Interface: Main

Defined in: web/lib/api/generated/types/site/standard/document.ts:15

Indexable​

[k: string]: unknown

Properties​

$type​

$type: "site.standard.document"

Defined in: web/lib/api/generated/types/site/standard/document.ts:16

bskyPostRef?​

optional bskyPostRef: Main

Defined in: web/lib/api/generated/types/site/standard/document.ts:32

content?​

optional content: object

Defined in: web/lib/api/generated/types/site/standard/document.ts:27

$type​

$type: string

contributors?​

optional contributors: Contributor[]

Defined in: web/lib/api/generated/types/site/standard/document.ts:39

coverImage?​

optional coverImage: BlobRef

Defined in: web/lib/api/generated/types/site/standard/document.ts:31

Image to used for thumbnail or cover image. Less than 1MB is size.

description?​

optional description: string

Defined in: web/lib/api/generated/types/site/standard/document.ts:34

A brief description or excerpt from the document.

labels?​

optional labels: $Typed<SelfLabels> | { $type: string; }

Defined in: web/lib/api/generated/types/site/standard/document.ts:26

optional links: object

Defined in: web/lib/api/generated/types/site/standard/document.ts:23

$type​

$type: string

path?​

optional path: string

Defined in: web/lib/api/generated/types/site/standard/document.ts:18

Combine with site or publication url to construct a canonical URL to the document. Prepend with a leading slash.

publishedAt​

publishedAt: string

Defined in: web/lib/api/generated/types/site/standard/document.ts:36

Timestamp of the documents publish time.

site​

site: string

Defined in: web/lib/api/generated/types/site/standard/document.ts:20

Points to a publication record (at://) or a publication url (https://) for loose documents. Avoid trailing slashes.

tags?​

optional tags: string[]

Defined in: web/lib/api/generated/types/site/standard/document.ts:22

Array of strings used to tag or categorize the document. Avoid prepending tags with hashtags.

textContent?​

optional textContent: string

Defined in: web/lib/api/generated/types/site/standard/document.ts:38

Plaintext representation of the documents contents. Should not contain markdown or other formatting.

title​

title: string

Defined in: web/lib/api/generated/types/site/standard/document.ts:25

Title of the document.

updatedAt?​

optional updatedAt: string

Defined in: web/lib/api/generated/types/site/standard/document.ts:29

Timestamp of the documents last edit.