2019-08-21 12:37:02 +00:00
# @apiglobal/typedrequest
make typed requests towards apis
## Availabililty and Links
* [npmjs.org (npm package) ](https://www.npmjs.com/package/@apiglobal/typedrequest )
* [gitlab.com (source) ](https://gitlab.com/apiglobal/typedrequest )
* [github.com (source mirror) ](https://github.com/apiglobal/typedrequest )
* [docs (typedoc) ](https://apiglobal.gitlab.io/typedrequest/ )
## Status for master
2020-06-15 16:39:48 +00:00
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)
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
2019-08-21 12:37:02 +00:00
## Usage
2020-06-15 16:52:56 +00:00
Use TypeScript for best in class intellisense.
2020-02-11 18:55:07 +00:00
2020-09-14 08:22:27 +00:00
```typescript
import { expect, tap } from '@pushrocks/tapbundle';
import * as smartexpress from '@pushrocks/smartexpress';
import * as typedrequest from '../ts/index';
let testServer: smartexpress.Server;
let testTypedHandler: typedrequest.TypedHandler< ITestReqRes > ;
// lets define an interface
interface ITestReqRes {
method: 'hi';
request: {
name: string;
};
response: {
surname: string;
};
}
tap.test('should create a typedHandler', async () => {
// lets use the interface in a TypedHandler
2020-10-06 15:05:29 +00:00
testTypedHandler = new typedrequest.TypedHandler< ITestReqRes > ('hi', async (reqArg) => {
2020-09-14 08:22:27 +00:00
return {
2020-10-06 15:05:29 +00:00
surname: 'wow',
2020-09-14 08:22:27 +00:00
};
});
});
tap.test('should spawn a server to test with', async () => {
testServer = new smartexpress.Server({
cors: true,
forceSsl: false,
2020-10-06 15:05:29 +00:00
port: 3000,
2020-09-14 08:22:27 +00:00
});
});
tap.test('should define a testHandler', async () => {
const testTypedRouter = new typedrequest.TypedRouter(); // typed routers can broker typedrequests between handlers
testTypedRouter.addTypedHandler(testTypedHandler);
testServer.addRoute(
'/testroute',
2020-09-14 08:28:07 +00:00
new smartexpress.HandlerTypedRouter(testTypedRouter as any) // the "any" is testspecific, since smartexpress ships with its own version of typedrequest.
2020-09-14 08:22:27 +00:00
);
});
tap.test('should start the server', async () => {
await testServer.start();
});
tap.test('should fire a request', async () => {
const typedRequest = new typedrequest.TypedRequest< ITestReqRes > (
'http://localhost:3000/testroute',
'hi'
);
const response = await typedRequest.fire({
2020-10-06 15:05:29 +00:00
name: 'really',
2020-09-14 08:22:27 +00:00
});
console.log('this is the response:');
console.log(response);
expect(response.surname).to.equal('wow');
});
tap.test('should end the server', async () => {
await testServer.stop();
});
tap.start();
```
2020-02-11 18:55:07 +00:00
## 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 ). :)
2019-08-21 12:37:02 +00:00
For further information read the linked docs at the top of this readme.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
| By using this npm module you agree to our [privacy policy ](https://lossless.gmbH/privacy )
[](https://maintainedby.lossless.com)
