Skip to content
This repository has been archived by the owner on Oct 11, 2023. It is now read-only.

1ziton/socket-sdk

Repository files navigation

socket-sdk

styled with prettier NPM version Greenkeeper badge Build Status Coveralls

Socket SDK for JavaScript

Usage

npm install socket-sdk

Importing library

You can import the generated bundle to use the whole library generated by this starter:

import SocketClient from 'socket-sdk';

Additionally, you can import the transpiled modules from dist/lib in case you have a modular library:

import SocketClient from 'socket-sdk/dist/lib/socket-sdk';

API

API Document

NPM scripts

  • npm t: Run test suite
  • npm start: Run npm run build in watch mode
  • npm run test:watch: Run test suite in interactive watch mode
  • npm run test:prod: Run linting and generate coverage
  • npm run build: Generate bundles and typings, create docs
  • npm run lint: Lints code
  • npm run commit: Commit using conventional commit style (husky will tell you to use it if you haven't 😉)

Relation

Contributing

  • Fork it!
  • Create your feature branch: git checkout -b my-new-feature
  • Commit your changes: git commit -m 'Add some feature'
  • Push to the branch: git push origin my-new-feature
  • Submit a pull request :D

License

@1ziton MIT