Skip to main content

PackageOverrides

@iota/audit-trails API documentation

Class: PackageOverrides

Package-ID overrides used when targeting custom audit-trail deployments.

Remarks​

Pass an instance of this type to AuditTrailClientReadOnly.createWithPackageOverrides or AuditTrailClient.createFromIotaClientWithPackageOverrides when the connected network hosts the audit-trail package — and optionally the tf_components package — at addresses that are not part of the audit-trail package's built-in registry. Leave a field unset to fall back to the registry lookup for that package.

Constructors​

Constructor​

new PackageOverrides(audit_trail_package_id?, tf_components_package_id?): PackageOverrides

Creates package overrides for custom deployments.

Parameters​

audit_trail_package_id?​

string | null

tf_components_package_id?​

string | null

Returns​

PackageOverrides

Accessors​

auditTrailPackageId​

Get Signature​

get auditTrailPackageId(): string | undefined

Override for the audit-trail package ID.

Returns​

string | undefined

Set Signature​

set auditTrailPackageId(value): void

Override for the audit-trail package ID.

Parameters​
value​

string | null | undefined

Returns​

void

tfComponentsPackageId​

Get Signature​

get tfComponentsPackageId(): string | undefined

Override for the tf_components package ID.

Returns​

string | undefined

Set Signature​

set tfComponentsPackageId(value): void

Override for the tf_components package ID.

Parameters​
value​

string | null | undefined

Returns​

void

Methods​

toJSON()​

toJSON(): Object

  • Return copy of self without private attributes.

Returns​

Object

toString()​

toString(): string

Return stringified version of self.

Returns​

string