50 lines
2.8 KiB
Markdown
50 lines
2.8 KiB
Markdown
|
# @apiglobal/typedserver
|
||
|
|
easy serving of static files
|
||
|
|
|
||
|
|
## Availabililty and Links
|
||
|
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@apiglobal/typedserver)
|
||
|
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/typedserver)
|
||
|
|
* [github.com (source mirror)](https://github.com/pushrocks/typedserver)
|
||
|
|
* [docs (typedoc)](https://pushrocks.gitlab.io/typedserver/)
|
||
|
|
|
||
|
|
## Status for master
|
||
|
|
|
||
|
|
Status Category | Status Badge
|
||
|
|
-- | --
|
||
|
|
GitLab Pipelines | [](https://lossless.cloud)
|
||
|
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||
|
|
npm | [](https://lossless.cloud)
|
||
|
|
Snyk | [](https://lossless.cloud)
|
||
|
|
TypeScript Support | [](https://lossless.cloud)
|
||
|
|
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||
|
|
Code Style | [](https://lossless.cloud)
|
||
|
|
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||
|
|
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||
|
|
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Use TypeScript for best in class instellisense.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
import { TypedServer } from '@apiglobal/typedserver';
|
||
|
|
|
||
|
|
let myTypedserver = new TypedServer('/some/path/to/webroot', 8080);
|
||
|
|
myTypedserver.start().then(() => {
|
||
|
|
// this is executed when server is running guaranteed
|
||
|
|
myTypedserver.stop(); // .stop() will work even if not waiting for server to be fully started
|
||
|
|
});
|
||
|
|
|
||
|
|
myTypedserver.reload(); // reloads all connected browsers of this instance
|
||
|
|
```
|
||
|
|
|
||
|
|
## Contribution
|
||
|
|
|
||
|
|
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). :)
|
||
|
|
|
||
|
|
For further information read the linked docs at the top of this readme.
|
||
|
|
|
||
|
|
## Legal
|
||
|
|
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
||
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|