Class Agent

An Agent is a user or machine that can write data to an Atomic Server. An Agent might not have subject, sometimes. https://atomicdata.dev/classes/Agent

Hierarchy

Agent

Implements

AgentInterface

Index

Constructors

Properties

client privateKey publicKey? subject?

Methods

buildSecret getPublicKey verifyPublicKeyWithServer fromSecret

Constructors

constructor

new Agent(privateKey: string, subject?: string): Agent
Parameters
- privateKey: string
- Optional subject: string
Returns Agent
- Defined in lib/dist/src/agent.d.ts:11

Properties

client

client: Client

privateKey

privateKey: string

https://atomicdata.dev/properties/privateKey

`Optional` publicKey

publicKey?: string

https://atomicdata.dev/properties/publicKey

`Optional` subject

subject?: string

URL of the Agent

Methods

buildSecret

buildSecret(): string
Returns a base64 encoded JSON object containing the Subject and the Private Key. Used for signing in with one string

Returns string
- Defined in lib/dist/src/agent.d.ts:23

getPublicKey

getPublicKey(): Promise<string>
Returns public key or generates one using the private key

Returns Promise<string>
- Defined in lib/dist/src/agent.d.ts:18

verifyPublicKeyWithServer

verifyPublicKeyWithServer(): Promise<void>
Fetches the public key for the agent, checks if it matches with the current one

Returns Promise<void>
- Defined in lib/dist/src/agent.d.ts:25

`Static` fromSecret

fromSecret(secretB64: string): Agent
Parses a base64 JSON object containing a privateKey and subject, and constructs an Agent from that.
Parameters
- secretB64: string
Returns Agent
- Defined in lib/dist/src/agent.d.ts:16

Generated using TypeDoc