npm

@reshuffle/base-connector
TypeScript icon, indicating that this package has built-in type declarations

0.0.12 • Public • Published

reshuffle-base-connector

Base class for Reshuffle Connectors

Get started

To implement a new connector, create a new class extending the BaseConnector class from this package.

Example:

import { BaseConnector } from 'reshuffle-base-connector'

class MyCustomConnector extends BaseConnector<MyConnectorConfigOptions, MyConnectorEventOptions> {
    
  constructor(options, id /* your custom options */) {
    super(id)
    // Set your custom options here
  }
    
  onStart() {
    // ...
  }
    
  onStop() {
    // ...
  }
 
  on(options: EventOptionsType, eventId: EventConfiguration['id']): EventConfiguration {
    // ...
  }

}

Package Sidebar

Install

npm i @reshuffle/base-connector

Weekly Downloads

0

Version

0.0.12

License

MIT

Unpacked Size

30.9 kB

Total Files

35

Last publish

Collaborators

  • avnerbraverman
  • spacebug
  • ashevat
  • lagache
  • duckranger