npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@pera-swarm/types

v1.0.1

Published

The types associated with Pera-Swarm

Downloads

5

Readme

types

Types associated with Pera-Swarm

Summary

Pera-Swarm/types repository is created for handling all the type definitions in one place as it is convenient with the modules. Also this repository will reflect the pera-swarm library architecture and all of it's type declarations.

Architecture

  • Internal Types:

    • CoordinateType, MessageType
  • Internal Classes:

    • Coordinate, Message
  • External Types:

    • SensorType, RobotType, ModeType
  • External Classes:

    • Sensor, Robot, Mode

File structure

.
├── ...
├── dist/                    # Build files (ignored by git and built using `tsc`)
├── lib/                     # Library files
├── test/                    # Test files
├── global.d.ts              # Global type declaration file
└── index.d.ts               # Typings for the target package `@types/pera-swarm` only
...

Contribute

1. Install dependencies

Install project dependencies.

$ npm install

Install typescript globally if you haven't installed already.

$ npm install -g typescript

2. Compile

This will generate the dist folder locally. Run the typescript compiler if you have typescript installed globally.

$ npm run compile

or

$ tsc

Run the compiler in watch mode.

$ npm run dev

or

$ tsc --watch

3. Testing

Note: Before running the test cases, you should compile the typescript files as described in the step 2.

$ npm test

or run test cases in watch mode.

$ npm run test:watch

To-Do

Contribute to TypeScript Community and create @types/pera-swarm library for convenience.

Licence

This project is licensed under LGPL-2.1 Licence.