Create a new message.
string An identifier which will identify the message's source.
TapjawPayload A Record<string, unknown> payload with all properties sorted by the key name to guarantee a consistent signature between API responses.
Date An optional date for the message. (Default: current UTC date/time)
The date/time this message was created.
An arbitrary payload from a third party source.
A SHA256 hash of the payload content.
Collective identifier from the origin of this message.
For Example: Name of the service which provided the payload.
Sha256 secret for salting the message signature.
string
Generated using TypeDoc
Default Tapjaw Importer data-interchange message container
The primary feature of the class is to contain an arbitrary key=>value styled payload and associated metadata about the payload. The payload is designed as a "free object" (Record<string, unknown>) to allow API responses to get stored after being parsed and formatted by an adapter.
The designed purpose of
TapjawMessage
is to allow for data interchange between commands with a consistent schema, all messages which inherit theTapjawMessage
class will automatically acquire a sha256signature
property hashed from the payload. Additionally, asourceProviderName
andimport_date
properties are present for grouping purposes.After the message has passed through
JSON.stringify()
, it will generally have an output looking similar to: