@actyx/sdk
TypeScript icon, indicating that this package has built-in type declarations

0.5.9 • Public • Published

A open-source Typescript/Javascript SDK for interacting the Actyx APIs:

  • Emit, query, and subscribe to events that get distributed via Actyx
  • Get Actyx diagnostics
  • Scoped to your custom app id

This SDK is the basis for the more frequently used Actyx Pond framework.

Example usage

import { Actyx, Tags } from '@actyx/sdk'

(async () => {

    // Connect to the local Actyx process
    const actyx = await Actyx.of({
        appId: 'com.example.app',
        displayName: 'Example App',
        version: '1.0.0'
    })

    // Get latest event stream offsets
    const offsets = await actyx.offsets()
    console.log(offsets)

    // Emit events
    await actyx.emit([
        {
            tags: ['tag-1', 'tag-2'],
            event: {
                foo: 'bar'
            }
        }
    ])

    // Subscribe to events
    await actyx.subscribe({
        query: Tags('tag-1').and('tag-2')
    }, event => {
        console.log(event)
    })
})()

Package Sidebar

Install

npm i @actyx/sdk

Weekly Downloads

144

Version

0.5.9

License

GPL-2.0-only

Unpacked Size

5.35 MB

Total Files

2524

Last publish

Collaborators

  • kelerchian
  • roland.kuhn
  • ostollmann