@tws-js/client
v1.1.0
Published
Type-Safe Web Server Client
Downloads
5
Readme
TWS - Type-Safe Web Server Client
✅ 100% code coverage
Usage
Install the package:
npm install @tws-js/client
Generate the types passing the URL of a TWS server schema:
npx tws-types --server http://localhost:3000/tws/schema --output server-types.ts
Finally use the generated types in your client code:
import { TwsClient } from '@tws-js/client';
import { TwsTypes } from './server-types';
const client = new TwsClient<TwsTypes>({
// The URL of your TWS server. Also works with remote servers.
url: 'http://localhost:3000/tws',
});
// Response and input types are automatically inferred
const response = await client.execute('myOperation', {
name: 'TWS',
});
Collaborating
Setup
nvm use 18
npm install
Building
npm run build
Testing
npm run lint
npm test