Skip to main content

@eventcatalog/sdk/0

EventCatalog SDK

The EventCatalog SDK provides methods to interact with domains, services, and messages.

Installation

npm install @eventcatalog/sdk

Usage

import utils from '@eventcatalog/sdk';

const { getEvent } = utils(PATH_TO_CATALOG);

// Get an event by the id
const event = getEvent('event-name');

// Get an event by the id and it's version
const event = getEvent('event-name', '0.3.4');

Index

Functions

Type Aliases

Type Aliases

EventCatalogObject

EventCatalogObject: { catalogVersion: string; createdAt: string; resources: { channels?: ExportedResource<Channel>[]; customDocs?: ExportedResource<CustomDoc>[]; domains?: ExportedResource<Domain>[]; messages?: { commands?: ExportedResource<Command>[]; events?: ExportedResource<Event>[]; queries?: ExportedResource<Query>[] }; services?: ExportedResource<Service>[]; teams?: ExportedResource<Team>[]; users?: ExportedResource<User>[] }; version: string }
Page Options