{"id":22843210,"url":"https://github.com/pera-swarm/types","last_synced_at":"2025-03-31T05:11:18.917Z","repository":{"id":57135815,"uuid":"315066329","full_name":"Pera-Swarm/types","owner":"Pera-Swarm","description":"Types associated with Pera-Swarm","archived":false,"fork":false,"pushed_at":"2020-11-26T15:05:11.000Z","size":35,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-06T09:35:52.366Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-2.1","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Pera-Swarm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-22T15:15:48.000Z","updated_at":"2020-11-26T15:19:46.000Z","dependencies_parsed_at":"2022-09-04T09:10:12.793Z","dependency_job_id":null,"html_url":"https://github.com/Pera-Swarm/types","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pera-Swarm%2Ftypes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pera-Swarm%2Ftypes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pera-Swarm%2Ftypes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pera-Swarm%2Ftypes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Pera-Swarm","download_url":"https://codeload.github.com/Pera-Swarm/types/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246418642,"owners_count":20773938,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-13T02:13:24.648Z","updated_at":"2025-03-31T05:11:18.900Z","avatar_url":"https://github.com/Pera-Swarm.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# types [![npm (scoped)](https://img.shields.io/npm/v/@pera-swarm/types.svg)](https://github.com/Pera-Swarm/types/) [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/Pera-Swarm/types/%F0%9F%9A%80%20Release)](https://github.com/Pera-Swarm/types/releases) [![GitHub issues](https://img.shields.io/github/issues/Pera-Swarm/types)](https://github.com/Pera-Swarm/types/issues)\nTypes associated with Pera-Swarm\n\n## Summary\n`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`](https://github.com/Pera-Swarm/pera-swarm) library architecture and all of it's type declarations.\n\n### Architecture\n\n- Internal Types:\n  - CoordinateType, MessageType\n- Internal Classes:\n  - Coordinate, Message\n\n- External Types:\n  - SensorType, RobotType, ModeType\n- External Classes:\n  - Sensor, Robot, Mode\n\n### File structure\n    .\n    ├── ...\n    ├── dist/                    # Build files (ignored by git and built using `tsc`)\n    ├── lib/                     # Library files\n    ├── test/                    # Test files\n    ├── global.d.ts              # Global type declaration file\n    └── index.d.ts               # Typings for the target package `@types/pera-swarm` only\n    ...\n\n### Contribute\n\n#### 1. Install dependencies\n\nInstall project dependencies.\n```\n$ npm install\n```\nInstall typescript globally if you haven't installed already.\n```\n$ npm install -g typescript\n```\n\n#### 2. Compile\n\nThis will generate the `dist` folder locally.\nRun the typescript compiler if you have typescript installed globally.\n```\n$ npm run compile\n```\nor\n```\n$ tsc\n```\n\nRun the compiler in watch mode.\n```\n$ npm run dev\n```\nor\n```\n$ tsc --watch\n```\n\n#### 3. Testing\n\n\u003e Note: Before running the test cases, you should compile the typescript files as described in the step 2.\n```\n$ npm test\n```\nor run test cases in watch mode.\n```\n$ npm run test:watch\n```\n\n### To-Do\nContribute to [TypeScript Community](https://github.com/DefinitelyTyped/DefinitelyTyped/) and create `@types/pera-swarm` library for convenience.\n\n### Licence\nThis project is licensed under [LGPL-2.1 Licence](https://github.com/Pera-Swarm/types/blob/main/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpera-swarm%2Ftypes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpera-swarm%2Ftypes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpera-swarm%2Ftypes/lists"}