Skip to main content

KeyworkDocumentMetadata

Overview​

Metadata associated with a specific KeyworkDocument

Remarks​

JSON serializable.

Usage​

import { KeyworkDocumentMetadata } from 'keywork/collections'

Hierarchy​

Properties​

absoluteDocPath​

absoluteDocPath: `string`

Full path to document.

Defined in​

collections/KeyworkDocumentMetadata.ts:49

createdAt​

createdAt: `string`

Defined in​

collections/KeyworkDocumentMetadata.ts:52

deserializeAs​

deserializeAs: [`DeserializationTransformers`](../types/DeserializationTransformers.mdx)

Defaults to text String

Defined in​

collections/KeyworkDocumentMetadata.ts:55

etag​

etag: `null` | `string`

An optional ETag of the value associated with this document.

See​

Defined in​

collections/KeyworkDocumentMetadata.ts:62

expiration​

optional expiration: `number`

Inherited from​

PutOrPatchOptions.expiration

Defined in​

collections/KeyworkCollection/common.ts:18

expirationTtl​

optional expirationTtl: `number`

Inherited from​

PutOrPatchOptions.expirationTtl

Defined in​

collections/KeyworkCollection/common.ts:19

id​

id: `string`

The document's ULID identifier within its collection.

Defined in​

collections/KeyworkDocumentMetadata.ts:47

relativeDocPath​

relativeDocPath: `string`

Relative path to document from parent collection.

Defined in​

collections/KeyworkDocumentMetadata.ts:51

updatedAt​

updatedAt: `string`

Defined in​

collections/KeyworkDocumentMetadata.ts:53