{"id":18218876,"url":"https://github.com/delight-rpc/browser","last_synced_at":"2026-02-23T23:05:04.570Z","repository":{"id":44843768,"uuid":"425812567","full_name":"delight-rpc/browser","owner":"delight-rpc","description":"🌲","archived":false,"fork":false,"pushed_at":"2025-11-03T05:59:38.000Z","size":1086,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-11-03T06:02:54.308Z","etag":null,"topics":["browser","esm","library","npm-package","typescript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@delight-rpc/browser","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/delight-rpc.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-11-08T11:34:28.000Z","updated_at":"2025-11-03T05:59:42.000Z","dependencies_parsed_at":"2023-12-04T03:23:34.081Z","dependency_job_id":"1d8e0731-2909-45ff-84dc-9d22a8a39e21","html_url":"https://github.com/delight-rpc/browser","commit_stats":{"total_commits":96,"total_committers":2,"mean_commits":48.0,"dds":"0.10416666666666663","last_synced_commit":"75782bdd262d712b02d6fdfd8bd395b359690554"},"previous_names":[],"tags_count":33,"template":false,"template_full_name":null,"purl":"pkg:github/delight-rpc/browser","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delight-rpc%2Fbrowser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delight-rpc%2Fbrowser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delight-rpc%2Fbrowser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delight-rpc%2Fbrowser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/delight-rpc","download_url":"https://codeload.github.com/delight-rpc/browser/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delight-rpc%2Fbrowser/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29760099,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-23T21:02:23.375Z","status":"ssl_error","status_checked_at":"2026-02-23T20:58:31.539Z","response_time":90,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["browser","esm","library","npm-package","typescript"],"created_at":"2024-11-03T18:04:59.906Z","updated_at":"2026-02-23T23:05:04.530Z","avatar_url":"https://github.com/delight-rpc.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @delight-rpc/browser\n## Install\n```sh\nnpm install --save @delight-rpc/browser\n# or\nyarn add @delight-rpc/browser\n```\n\n## Usage\n### Web Worker\n#### Main as Client, Web Worker as Server\n```ts\n// api.d.ts\ninterface IAPI {\n  echo(message: string): string\n}\n\n// main.ts\nimport { createClient } from '@delight-rpc/browser'\n\nconst worker = new Worker('./worker.js')\nconst [client] = createClient\u003cIAPI\u003e(worker)\nawait client.echo('hello world')\n\n// worker.ts\nimport { createServer } from '@delight-rpc/browser'\n\nconst api: IAPI = {\n  echo(message) {\n    return message\n  }\n}\n\ncreateServer(api, self)\n```\n\n#### Web Worker as Client, Main as Server\n```ts\n// api.d.ts\ninterface IAPI {\n  echo(message: string): string\n}\n\n// main.ts\nimport { createServer } from '@delight-rpc/browser'\n\nconst api: IAPI = {\n  echo(message) {\n    return message\n  }\n}\n\nconst worker = new Worker('./worker.js')\ncreateServer(api, worker)\n\n// worker.ts\nimport { createClient } from '@delight-rpc/browser'\n\nconst [client] = createClient\u003cIAPI\u003e(self)\nawait client.echo('hello world')\n```\n\n### MessageChannel\n```ts\ninterface IAPI {\n  echo(message: string): string\n}\n\nconst api: IAPI = {\n  echo(message) {\n    return message\n  }\n}\n\nconst channel = new MessageChannel()\nchannel.port1.start()\nchannel.port2.start()\n\ncreateServer\u003cIAPI\u003e(api, channel.port1)\n\nconst [client] = createClient\u003cIAPI\u003e(channel.port2)\nawait client.echo('hello world')\n```\n\n## API\n### createClient\n```ts\nfunction createClient\u003cIAPI extends object\u003e(\n  port: Window | MessagePort | Worker\n, options?: {\n    parameterValidators?: DelightRPC.ParameterValidators\u003cIAPI\u003e\n    expectedVersion?: string\n    channel?: string\n  }\n): [client: DelightRPC.ClientProxy\u003cIAPI\u003e, close: () =\u003e void]\n```\n\n### createBatchClient\n```ts\nfunction createBatchClient\u003cDataType\u003e(\n  port: Window | MessagePort | Worker\n, options?: {\n    expectedVersion?: string\n    channel?: string\n  }\n): [client: DelightRPC.BatchClient\u003cDataType\u003e, close: () =\u003e void]\n```\n\n### createServer\n```ts\nfunction createServer\u003cIAPI extends object\u003e(\n  api: DelightRPC.ImplementationOf\u003cIAPI\u003e\n, port: Window | MessagePort | Worker\n, options?: {\n    parameterValidators?: DelightRPC.ParameterValidators\u003cIAPI\u003e\n    version?: `${number}.${number}.${number}`\n    channel?: string | RegExp | AnyChannel\n    ownPropsOnly?: boolean\n  }\n): () =\u003e void\n```\n\n### createHTTPHandler\n```ts\nfunction createHTTPHandler\u003cIAPI\u003e(\n  api: DelightRPC.ImplementationOf\u003cIAPI\u003e\n, options?: {\n    basicAuth?: (username: string, password: string) =\u003e Awaitable\u003cboolean\u003e\n    parameterValidators?: DelightRPC.ParameterValidators\u003cIAPI\u003e\n    version?: `${number}.${number}.${number}`\n    ownPropsOnly?: boolean\n    channel?: string | RegExp | typeof DelightRPC.AnyChannel\n  }\n): (req: Request) =\u003e Promise\u003cResponse\u003e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdelight-rpc%2Fbrowser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdelight-rpc%2Fbrowser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdelight-rpc%2Fbrowser/lists"}