EntityFields

EntityFields = object

Defined in: src/types/entity.ts:9

The fields an Entity can carry. Every one is optional: a query returns exactly the parts it selected, and undefined means “not asked for” rather than “empty”.

Properties

attributes?

optional attributes: Attributes

Defined in: src/types/entity.ts:26

Attribute names, types and values.

---

attributeSchema?

optional attributeSchema: AttributeSchema

Defined in: src/types/entity.ts:24

Attribute names and types, with no values.

---

contentType?

optional contentType: string

Defined in: src/types/entity.ts:21

---

createdAt?

optional createdAt: bigint

Defined in: src/types/entity.ts:14

Block the entity was created at.

---

creationFlags?

optional creationFlags: ResolvedCreationFlags

Defined in: src/types/entity.ts:20

The immutable properties the entity was created with.

---

creator?

optional creator: Hex

Defined in: src/types/entity.ts:12

---

expiresAt?

optional expiresAt: bigint

Defined in: src/types/entity.ts:18

Block the entity expires at.

---

key?

optional key: Hex

Defined in: src/types/entity.ts:10

---

owner?

optional owner: Hex

Defined in: src/types/entity.ts:11

---

payload?

optional payload: Uint8Array

Defined in: src/types/entity.ts:22

---

updatedAt?

optional updatedAt: bigint

Defined in: src/types/entity.ts:16

Block the entity was last patched at.