Security News
Bun 1.2 Released with 90% Node.js Compatibility and Built-in S3 Object Support
Bun 1.2 enhances its JavaScript runtime with 90% Node.js compatibility, built-in S3 and Postgres support, HTML Imports, and faster, cloud-first performance.
@vscode/sync-api-common
Advanced tools
An RPC implementation between Web and NodeJS workers that works sync
This npm module implements a sync communication mechanism between two web workers, include the main worker running either in Node or in a Browser. This for example allows to access async API from another worker in sync form.
The implementation depends on SharedArrayBuffers
and Atomics
. So you need a decent version of Node. On the browser side various headers need to be enabled. Please check MDN for the corresponding details. Also note that the code works best if typed arrays are transferred (e.g. Uint8Array, ...) since they can easily be mapped into shared arrays. JSON structures might need two calls to the service (done by the library) to receive the data.
Main worker offers an API getValue(arg: number): Promise<string>
which you want to access from another worker which solely has sync API. The setup for code running under node looks as follows:
A common file were the sync RPC requests are defined (e.g. requests.ts
).
import { VariableResult } from '@vscode/sync-api-common';
export type Requests = {
method: 'getValue';
params: {
arg: number;
};
result: VariableResult<{ value: string }>;
}
The setup in the worker looks like this:
import { ClientConnection } from '@vscode/sync-api-common/browser';
import { Requests } from './requests';
const connection = new ClientConnection<Requests>(parentPort);
await connection.serviceReady();
// Note that this is a sync call with no await needed.
const requestResult = connection.sendRequest('getValue', { arg: 10 }, new VariableResult('json'));
// An error has occurred.
if (requestResult.errno !== 0) {
}
// Get the actual data
const value = requestResult.data.value;
The main side looks like this:
import { ServiceConnection } from '@vscode/sync-api-common';
import { Requests } from './requests';
// The worker to access API in sync from.
const worker = new Worker('...');
const connection = new ServiceConnection<Requests>(worker);
// The request handler for getValue
connection.onRequest('getValue', async (params) => {
const str = await getValue(params.arg);
return { errno: 0, data: { value: str } };
});
// Signal connection ready so that the worker can call
// sync API.
connection.signalReady();
For code executed in the desktop exchange the import @vscode/sync-api-common/browser
with @vscode/sync-api-common/node
.
FAQs
An RPC implementation between Web and NodeJS workers that works sync
The npm package @vscode/sync-api-common receives a total of 3,661 weekly downloads. As such, @vscode/sync-api-common popularity was classified as popular.
We found that @vscode/sync-api-common demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 7 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Bun 1.2 enhances its JavaScript runtime with 90% Node.js compatibility, built-in S3 and Postgres support, HTML Imports, and faster, cloud-first performance.
Security News
Biden's executive order pushes for AI-driven cybersecurity, software supply chain transparency, and stronger protections for federal and open source systems.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.