Registry /
messaging / integration-websocket-rest-api
Install & Compatibility
Where this runs
No compatibility data collected yet for this library.
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
ApiClient
✓ import { ApiClient } from 'integration-websocket-rest-api'
✗ import ApiClient from 'integration-websocket-rest-api'
This is a named export. Using default import will result in undefined at runtime.
WebSocketClient
✓ import { WebSocketClient } from 'integration-websocket-rest-api'
✗ const WebSocketClient = require('integration-websocket-rest-api').WebSocketClient
The package ships TypeScript types and is ESM-first. CJS require may work but is not officially supported.
wsMessageReceived
✓ import { wsMessageReceived } from 'integration-websocket-rest-api'
Named export for the Redux action creator. Use it directly in dispatch calls.
apiRequestSuccess
✓ import { apiRequestSuccess } from 'integration-websocket-rest-api'
Named export for the Redux action creator. Use it in reducers or dispatching after API calls.
apiRequestFailure
✓ import { apiRequestFailure } from 'integration-websocket-rest-api'
Named export for the Redux action creator. Handles error states.
This example shows how to import ApiClient and WebSocketClient, configure them, and wire up Redux actions for state management.
import { ApiClient, WebSocketClient, wsMessageReceived, apiRequestSuccess, apiRequestFailure } from 'integration-websocket-rest-api';
import { createStore } from 'redux';
// Setup Redux store with a simple reducer
const initialState = { messages: [], apiData: null, error: null };
const reducer = (state = initialState, action) => {
switch(action.type) {
case 'WS_MESSAGE_RECEIVED':
return { ...state, messages: [...state.messages, action.payload] };
case 'API_REQUEST_SUCCESS':
return { ...state, apiData: action.payload };
case 'API_REQUEST_FAILURE':
return { ...state, error: action.payload };
default:
return state;
}
};
const store = createStore(reducer);
// Use ApiClient
const apiClient = new ApiClient('https://api.example.com');
apiClient.setGlobalHeaders({ Authorization: 'Bearer ' + (process.env.API_TOKEN ?? '') });
apiClient.sendRequest('GET', '/data', { timeout: 5000 }).subscribe(
(data) => store.dispatch(apiRequestSuccess(data)),
(err) => store.dispatch(apiRequestFailure(err.message))
);
// Use WebSocketClient
const wsClient = new WebSocketClient('wss://ws.example.com');
wsClient.openConnection();
wsClient.getMessage((message) => {
store.dispatch(wsMessageReceived(message));
});
wsClient.sendMessage({ type: 'subscribe', channel: 'updates' });
Errors
Common errors & fixes
Cannot find module 'integration-websocket-rest-api' or its corresponding type declarations.
Package not installed or TypeScript cannot resolve types (types are included but may not be picked up automatically).
fixInstall the package: npm install integration-websocket-rest-api. If types still missing, add 'integration-websocket-rest-api' to tsconfig.json types array or create a declaration file.
TypeError: apiClient.sendRequest is not a function
Importing ApiClient incorrectly (default import vs named import).
fixChange import to: import { ApiClient } from 'integration-websocket-rest-api'; Uncaught ReferenceError: Rx is not defined
RxJS is a peer dependency and not installed automatically.
fixInstall rxjs: npm install rxjs
Audit
Dependencies
axiosrequiredUsed for HTTP requests in ApiClient
reduxrequiredRequired for state management and action dispatching
rxjsrequiredUsed internally for observables (e.g., API calls return Observables)