Chisquare

SDK JS NG

Introduction

This is the Angular SDK for chisquare platform. It covers APIs for the following services:

• Events
• Files
• Forms
• Jobs
• Logs
• Messages
• Fuss
• Webhooks

Supported Platforms

• Browser
• Node.js (Javascript/Typescript)

Installation

1. NPM

$ npm i @chisquare-tech/ngx-sdk

Usage & API

0. Import Module

  import { EventModule } from '@chisquare-tech/ngx-sdk'

  imports:[
      ...
      EventModule.register({
          // config
      }),
      ...
  ]

1. Import Service

  import { EventService } from '@chisquare-tech/ngx-sdk'

  ...

      private readonly eventService = inject(EventService);

      OR
      
      constructor(
          private readonly eventService: EventService,
      ){}
  ...

Build

Run ng build ngx-sdk to build the project. The build artifacts will be stored in the dist/ directory.

Publishing

After building your library with ng build ngx-sdk, go to the dist folder cd dist/ngx-sdk and run npm publish.

Running unit tests

Run ng test ngx-sdk to execute the unit tests via Karma.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.