Skip to content

msquared-io/pixel-streaming-client

Repository files navigation

MSquared Pixel Streaming Client

npm version Build Status License: MIT TypeScript

Browser client for viewing pixel-streamed content from MSquared events.

Usage

For detailed documentation please visit our docs site.

Features

  • 🔒 Type-safe with full TypeScript support
  • 📦 Multiple distribution formats (ESM, CJS, UMD)
  • 🛠️ Easy integration with modern build tools

Build

npm run build

This will create:

  • CommonJS (CJS) build
  • ES Modules (ESM) build
  • Browser-ready bundle
  • TypeScript declaration files

Development

# Install dependencies
npm install

# Run tests
npm test

# Type checking
npm run ts:type-check

# Linting
npm run ts:lint
npm run ts:lint:fix

# Format code
npm run ts:fmt
npm run ts:fmt:fix

# Lint and format code
npm run ts:check
npm run ts:check:fix

# All validation checks
npm run ts:validate

Release

The GitHub Actions workflow will automatically publish the package to npm when a new release is created.

npm version <patch|minor|major>
git push --atomic origin main <version>

License

MIT © MSquared

About

Browser client for viewing pixel-streamed content from MSquared events.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •  

Languages