push.rocks/webglobal
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update tsconfig

Browse Source
This commit is contained in:
Philipp Kunz 2024-04-14 18:39:40 +02:00
parent 506f4ebba6
commit 6be13abd64
4 changed files with 86 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
npmextra.json
View File

@ -8,14 +8,22 @@
"shortDescription": "a better non polluting global module for efficient in browser communication",
"npmPackagename": "@push.rocks/webglobal",
"license": "MIT",
"projectDomain": "push.rocks"
"projectDomain": "push.rocks",
"description": "A better non-polluting global module for efficient in-browser communication.",
"keywords": [
"browser communication",
"TypeScript",
"global module",
"non-polluting",
"web development"
]
}
},
"npmci": {
"npmGlobalTools": [],
"npmAccessLevel": "public"
},
"tsdocs": {
"tsdoc": {
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
}
}

9
package.json
View File

@ -2,7 +2,7 @@
"name": "@push.rocks/webglobal",
"version": "1.0.2",
"private": false,
"description": "a better non polluting global module for efficient in browser communication",
"description": "A better non-polluting global module for efficient in-browser communication.",
"main": "dist/index.js",
"typings": "dist/index.d.ts",
"author": "Lossless GmbH",
@ -31,5 +31,12 @@
"cli.js",
"npmextra.json",
"readme.md"
],
"keywords": [
"browser communication",
"TypeScript",
"global module",
"non-polluting",
"web development"
]
}

1
readme.hints.md Normal file
View File

@ -0,0 +1 @@

88
readme.md
View File

@ -1,32 +1,78 @@
# @pushrocks/webglobal
# @push.rocks/webglobal
a better non polluting global module for efficient in browser communication
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/webglobal)
* [gitlab.com (source)](https://gitlab.com/pushrocks/webglobal)
* [github.com (source mirror)](https://github.com/pushrocks/webglobal)
* [docs (typedoc)](https://pushrocks.gitlab.io/webglobal/)
## Install
To install `@push.rocks/webglobal`, use the following npm command:
## Status for master
[![pipeline status](https://gitlab.com/pushrocks/webglobal/badges/master/pipeline.svg)](https://gitlab.com/pushrocks/webglobal/commits/master)
[![coverage report](https://gitlab.com/pushrocks/webglobal/badges/master/coverage.svg)](https://gitlab.com/pushrocks/webglobal/commits/master)
[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/webglobal.svg)](https://www.npmjs.com/package/@pushrocks/webglobal)
[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/webglobal/badge.svg)](https://snyk.io/test/npm/@pushrocks/webglobal)
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
```bash
npm install @push.rocks/webglobal --save
```
This will add it to your project's dependencies.
## Usage
Use TypeScript for best in class intellisense
To get started with `@push.rocks/webglobal`, first, ensure you are using TypeScript and your project is configured to support ES6 style module imports. This package is designed to provide a non-polluting global module for efficient in-browser communication, leveraging modern JavaScript practices for clean, scalable, and maintainable code.
## Contribution
### Importing the Module
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
In your project, after installation, you can import `@push.rocks/webglobal` as follows:
For further information read the linked docs at the top of this readme.
```typescript
import * as webglobal from '@push.rocks/webglobal';
```
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
Or, if you prefer destructuring to import specific parts of the module:
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)
```typescript
import { standardExport } from '@push.rocks/webglobal';
```
### Basic Usage
Initially, `@push.rocks/webglobal` provides a straightforward interface to work with. However, the essence of this module shines when you integrate it into a larger application context, requiring efficient global management without polluting the global namespace.
Below is an example demonstrating a simple use case:
```typescript
// Import the module
import { standardExport } from '@push.rocks/webglobal';
// Use the exported members
console.log(standardExport); // Expected output: 'Hi there! :) This is an exported string'
```
This example showcases how to import an exported string from the module. However, the true purpose of `@push.rocks/webglobal` is to facilitate in-browser communication efficiently. Assume that `standardExport` is a placeholder for more complex functionalities that you might integrate, such as managing global states, sharing data across components without direct coupling, or implementing a pub/sub system for event-driven architectures.
### Advanced Usage
Suppose your web application requires a modular approach to manage global events, such as user actions, system notifications, or external API responses. In that scenario, `@push.rocks/webglobal` can be extended to create a clean, maintainable event management system that doesn't interfere with the global scope or other libraries and frameworks you might be using.
Unfortunately, due to the nature of this template readme, a detailed implementation of such an advanced scenario would go beyond its intended scope. However, understanding the concept of ES6 imports, TypeScript's strong typing, and modular design principles will guide you towards implementing a solution that fits your specific needs without resorting to polluting the global namespace.
### Integration with Web Applications
Integrating `@push.rocks/webglobal` into your web application involves planning out the parts of your app that require global access or communication channels. This could mean setting up a global state management system, designing an event bus for cross-component communication, or anything similar that benefits from a centralized, non-polluting approach.
Remember, the key advantage of using this module is its commitment to maintaining a clean global scope, preventing the common issues associated with global variables and functions in JavaScript applications, especially in a browser environment.
To conclude, while this readme provides a starting point for using `@push.rocks/webglobal`, the real-world applications of such a module are largely dependent on the specific requirements of your project and your architectural design choices. By adhering to modern JavaScript standards and TypeScript, `@push.rocks/webglobal` aims to offer a scalable, efficient solution for managing global concerns in your web applications.
## License and Legal Information
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
### Trademarks
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
### Company Information
Task Venture Capital GmbH
Registered at District court Bremen HRB 35230 HB, Germany
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.