API reference / @evolu/common / Evolu/Protocol / DbChange

Variable: DbChange

const DbChange: ObjectType<{
  id: BrandType<
    Type<"String", string, string, StringError, string, StringError>,
    "Id",
    RegexError<"Id">,
    StringError
  >;
  table: BrandType<
    Type<
      "Brand",
      string & Brand<"Base64Url">,
      string,
      RegexError<"Base64Url">,
      string,
      StringError
    >,
    "MaxLength256",
    MaxLengthError<256>,
    StringError | RegexError<"Base64Url">
  >;
  values: RecordType<
    "Brand",
    string & Brand<"Base64Url"> & Brand<"MaxLength256">,
    string,
    MaxLengthError<256>,
    string & Brand<"Base64Url">,
    StringError | RegexError<"Base64Url">,
    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
        >,
      ]
    >
  >;
}>;

Defined in: packages/common/src/Evolu/Protocol.ts:336

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

Was this page helpful?