API reference / @evolu/common / local-first / DbChange

Variable: DbChange

const DbChange: ObjectType<{
  id: BrandType<
    Type<"String", string, string, StringError, string, StringError>,
    "Id",
    IdError,
    StringError
  >;
  isDelete: UnionType<
    [
      Type<"Null", null, null, NullError, null, NullError>,
      Type<"Boolean", boolean, boolean, BooleanError, boolean, BooleanError>,
    ]
  >;
  isInsert: Type<
    "Boolean",
    boolean,
    boolean,
    BooleanError,
    boolean,
    BooleanError
  >;
  table: Type<"String", string, string, StringError, string, StringError>;
  values: BrandType<
    RecordType<
      "String",
      string,
      string,
      StringError,
      string,
      StringError,
      UnionType<
        [
          Type<"Null", null, null, NullError, null, NullError>,
          Type<"String", string, string, StringError, string, StringError>,
          Type<"Number", number, number, NumberError, number, NumberError>,
          Type<
            "Uint8Array",
            Uint8Array<ArrayBufferLike>,
            Uint8Array<ArrayBufferLike>,
            Uint8ArrayError,
            Uint8Array<ArrayBufferLike>,
            Uint8ArrayError
          >,
        ]
      >
    >,
    "ValidDbChangeValues",
    ValidDbChangeValuesError,
    | RecordError<StringError, never>
    | RecordError<
        StringError,
        UnionError<Uint8ArrayError | NumberError | StringError | NullError>
      >
  >;
}>;

Defined in: packages/common/src/local-first/Storage.ts:290

A DbChange is a change to a table row. Together with a unique Timestamp, it forms a CrdtMessage.

Was this page helpful?