ModelBase

Optional hook called on each modified instance right before the transaction commits. Runs before data is written to disk, so changes made here are included in the commit.

Common use cases:

Computing derived or denormalized fields
Enforcing cross-field validation rules
Creating or updating related model instances (newly created instances will also have their preCommit() called)

Returns

void

Example

const Post = E.defineModel("Post", class {
  id = E.field(E.identifier);
  title = E.field(E.string);
  slug = E.field(E.string);

  preCommit() {
    this.slug = this.title.toLowerCase().replace(/\s+/g, "-");
  }
}, { pk: "id" });

_setLoadedField()

_setLoadedField(fieldName, value): void

Defined in: .work/repos/edinburgh/src/models.ts:735

Parameters

fieldName

string

value

any

Returns

void

_restoreLazyFields()

_restoreLazyFields(): void

Defined in: .work/repos/edinburgh/src/models.ts:749

Returns

void

getPrimaryKey()

getPrimaryKey(): Uint8Array

Defined in: .work/repos/edinburgh/src/models.ts:762

Returns

Uint8Array

The primary key for this instance.

_setPrimaryKey()

_setPrimaryKey(key, hash?): void

Defined in: .work/repos/edinburgh/src/models.ts:772

Parameters

key

Uint8Array

hash?

number

Returns

void

getPrimaryKeyHash()

getPrimaryKeyHash(): number

Defined in: .work/repos/edinburgh/src/models.ts:781

Returns

number

A 53-bit positive integer non-cryptographic hash of the primary key, or undefined if not yet saved.

isLazyField()

isLazyField(field): boolean

Defined in: .work/repos/edinburgh/src/models.ts:786

Parameters

field

keyof ModelBase<LOOKUP>

Returns

boolean

_write()

_write(txn): Change

Defined in: .work/repos/edinburgh/src/models.ts:791

Parameters

txn

Transaction

Returns

Change

preventPersist()

preventPersist(): ModelBase<LOOKUP>

Defined in: .work/repos/edinburgh/src/models.ts:881

Prevent this instance from being persisted to the database.

Returns

ModelBase<LOOKUP>

This model instance for chaining.

Example

const user = User.get("user123");
user.name = "New Name";
user.preventPersist(); // Changes won't be saved

delete()

delete(): void

Defined in: .work/repos/edinburgh/src/models.ts:902

Delete this model instance from the database.

Removes the instance and all its index entries from the database and prevents further persistence.

Returns

void

Example

const user = User.get("user123");
user.delete(); // Removes from database

validate()

validate(raise?): Error[]

Defined in: .work/repos/edinburgh/src/models.ts:921

Validate all fields in this model instance.

Parameters

raise?

boolean = false

If true, throw on first validation error.

Returns

Error[]

Array of validation errors (empty if valid).

Example

const user = new User();
const errors = user.validate();
if (errors.length > 0) {
  console.log("Validation failed:", errors);
}

isValid()

isValid(): boolean

Defined in: .work/repos/edinburgh/src/models.ts:946

Check if this model instance is valid.

Returns

boolean

true if all validations pass.

Example

const user = new User({name: "John"});
if (!user.isValid()) shoutAtTheUser();

getState()

getState(): "created" | "deleted" | "loaded" | "lazy"

Defined in: .work/repos/edinburgh/src/models.ts:950

Returns

"created" | "deleted" | "loaded" | "lazy"

toString()

toString(): string

Defined in: .work/repos/edinburgh/src/models.ts:961

Returns

string