{"id":38350501,"url":"https://github.com/brentd/interlinked","last_synced_at":"2026-01-17T03:08:07.496Z","repository":{"id":57275225,"uuid":"109215074","full_name":"brentd/interlinked","owner":"brentd","description":"🔗 Rx-enabled peer-to-peer RPC for JavaScript","archived":false,"fork":false,"pushed_at":"2018-08-06T16:33:06.000Z","size":176,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-12-27T08:57:28.159Z","etag":null,"topics":["reactive","reactive-programming","rpc","rx","rxjs"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/brentd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-11-02T03:48:34.000Z","updated_at":"2022-04-22T19:17:29.000Z","dependencies_parsed_at":"2022-09-16T11:12:17.718Z","dependency_job_id":null,"html_url":"https://github.com/brentd/interlinked","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/brentd/interlinked","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brentd%2Finterlinked","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brentd%2Finterlinked/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brentd%2Finterlinked/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brentd%2Finterlinked/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brentd","download_url":"https://codeload.github.com/brentd/interlinked/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brentd%2Finterlinked/sbom","scorecard":{"id":252332,"data":{"date":"2025-08-11","repo":{"name":"github.com/brentd/interlinked","commit":"c38daa04b258d5879b4269342113fd21da4ee9f8"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.3,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":0,"reason":"126 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-6chw-6frg-f759","Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25","Warn: Project is vulnerable to: GHSA-8w4h-3cm3-2pm2","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx","Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw","Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5","Warn: Project is vulnerable to: GHSA-c6rq-rjc2-86v2","Warn: Project is vulnerable to: GHSA-257v-vj4p-3w2h","Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-p28h-cc7q-c4fg","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-hr2v-3952-633q","Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9","Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm","Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2","Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w","Warn: Project is vulnerable to: GHSA-434g-2637-qmqr","Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m","Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw","Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p","Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747","Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh","Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h","Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc","Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx","Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3","Warn: Project is vulnerable to: MAL-2023-462","Warn: Project is vulnerable to: GHSA-xf7w-r453-m56c","Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6","Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9","Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f","Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p","Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv","Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8","Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65","Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh","Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44","Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988","Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq","Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm","Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-7r28-3m3f-r2pr","Warn: Project is vulnerable to: GHSA-r8j5-h5cx-65gg","Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546","Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp","Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq","Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488","Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g","Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574","Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm","Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3","Warn: Project is vulnerable to: GHSA-f9cm-qmx5-m98h","Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9","Warn: Project is vulnerable to: GHSA-92xj-mqp7-vmcj","Warn: Project is vulnerable to: GHSA-wxgw-qj99-44c2","Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5","Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp","Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq","Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr","Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765","Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g","Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p","Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr","Warn: Project is vulnerable to: GHSA-37q6-576q-vgr7","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w","Warn: Project is vulnerable to: GHSA-h7cp-r72f-jxh6","Warn: Project is vulnerable to: GHSA-v62p-rq8g-8h59","Warn: Project is vulnerable to: GHSA-566m-qj78-rww5","Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-hgch-jjmr-gp7w","Warn: Project is vulnerable to: GHSA-r3x4-wr4h-pw33","Warn: Project is vulnerable to: GHSA-876r-hj45-fw7g","Warn: Project is vulnerable to: GHSA-v63x-xc9j-hhvq","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg","Warn: Project is vulnerable to: GHSA-w5q7-3pr9-x44w","Warn: Project is vulnerable to: GHSA-3fjq-93xj-3f3f","Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p","Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp","Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr","Warn: Project is vulnerable to: GHSA-x9hc-rw35-f44h","Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7","Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw","Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc","Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p","Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q","Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh","Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-17T08:48:23.529Z","repository_id":57275225,"created_at":"2025-08-17T08:48:23.529Z","updated_at":"2025-08-17T08:48:23.529Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28492605,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T02:39:23.645Z","status":"ssl_error","status_checked_at":"2026-01-17T02:34:19.649Z","response_time":85,"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":["reactive","reactive-programming","rpc","rx","rxjs"],"created_at":"2026-01-17T03:08:06.925Z","updated_at":"2026-01-17T03:08:07.486Z","avatar_url":"https://github.com/brentd.png","language":"JavaScript","readme":"# Interlinked\n\n[![NPM version](https://img.shields.io/npm/v/interlinked.svg)](https://www.npmjs.com/package/interlinked)\n\nRx-enabled peer-to-peer RPC for JavaScript. It can expose an API of functions and streams to other JavaScript peers.\n\nNo dependencies other than [RxJS 6](https://github.com/reactivex/rxjs). Use any transport and serialization you like.\n\n**⚠️ This is alpha software and may be a terrible idea. The API is subject to change. ⚠️**\n\n## Installation\n\n```\nnpm install -S interlinked\n```\n\n## Usage\n\n```javascript\nimport interlinked from 'interlinked'\n\nconst transportIn  = // an observable of input from a connected peer\nconst transportOut = // an observer (object that implements `next()`) that outputs to the connected peer\n\n// The API to expose to peers.\nconst api = {\n  baseline: () =\u003e 'within cells interlinked'\n}\n\nconst link = interlinked(api)\n\ntransportIn.pipe(link(transportOut)).subscribe()\n```\n\nThen, on a connected peer:\n\n```javascript\nimport interlinked from 'interlinked'\n\n// This side does not expose an API.\nconst link = interlinked()\n\n// Peers can publish their API multiple times, so the source is\n// transformed into a stream of remote APIs.\ntransportIn.pipe(link(transportOut)).subscribe(remote =\u003e {\n  remote.baseline() // Promise resolve: 'within cells interlinked'\n})\n```\n\nHere, only one side exposes an API. However, Interlinked is peer-to-peer: both sides can expose an interface of functions and observables.\n\nThis is an incomplete example for brevity. For a working client/server implementation, see [the example directory](example/).\n\n### API\n\nInterlinked's API is a single function that returns an [RxJS pipeable operator](https://github.com/ReactiveX/rxjs/blob/master/doc/pipeable-operators.md). The operator transforms the input stream into a stream of proxy Objects that mirror the API exposed by the connected peer.\n\n```javascript\ninterlinked(api: Object, middlewares: Object[]) =\u003e operator(output: { next: Function }) =\u003e Observable\u003cObject\u003e\n```\n\n|Param|Type||Description|\n|---|---|---|---|\n| `api` | `Object` | optional | A plain object containing observables and functions that you want to expose to the connected peer. This object may be nested to help organize the API. |\n| `middlewares` | `Array\u003cObject\u003e` | optional | An array of middleware objects. Overrides the default stack; append your middlewares to the default stack if you want to extend it. |\n| `output` | `Object` | required | `{ next: (msg: Array\\|Object) =\u003e void }` \u003cbr\u003e\u003cbr\u003e Any object that responds to `next`. `next` takes one argument and must send the message through your transport to the connected peer. `msg` may be a JavaScript `Object` or `Array` of undefined depth - see [Protocol](#protocol). You are responsible for serializing Interlinked's transfer protocol for your transport. |\n\n## Supported Types\n\nInterlinked comes with support for three types of objects in the exposed API.\n\n### Functions\n\nFunctions simply return promises when called on a connected peer. The return value of the function can be any value supported by your serialization format, since Interlinked leaves serialization up to you.\n\n```javascript\ninterlinked({\n  hello: name =\u003e 'hello ' + name\n})\n\n// On a connected peer...\n\nremote.hello('Roy') // Promise resolve: 'hello Roy'\n```\n\n### Observables\n\nObservables are mirrored exactly when used on a connected peer and can be used as if they were local. Like functions, emitted values can be any type supported by your serialization format.\n\n```javascript\nimport { of } from 'rxjs'\n\ninterlinked({\n  counter: of(1, 2, 3)\n})\n\n// On a connected peer...\n\nremote.counter.subscribe({\n  next: x =\u003e console.log(x),\n  complete: () =\u003e console.log('Complete')\n})\n\n// 1\n// 2\n// 3\n// Complete\n```\n\n### Resources\n\nThis is a WIP type which allows you to define a REST-like interface for performing CRUD operations on a resource.\n\n```javascript\nimport { fromEvent } from 'rxjs'\nimport interlinked, { resource } from 'interlinked'\n\ninterlinked({\n  replicants: resource({\n    // Automatically send updated records every 10 minutes.\n    index: () =\u003e {\n      return interval(10 * 60 * 1000).pipe(map(someApi.getRecords))\n    },\n\n    // Maintain a subscription to a specific record's updates.\n    get: id =\u003e fromEvent(someApi, 'update')\n\n    create: () =\u003e {} // WIP\n    update: id =\u003e {} // WIP\n    delete: id =\u003e {} // WIP\n  })\n})\n\n// On a connected peer...\n\nremote.replicants.index() // Observable\u003cArray\u003e\nremote.replicants.get(id) // Observable\u003cObject\u003e\n```\n\n### Deeply nested properties\n\nThe exposed API may have properties of arbitrary depth - the full object tree will be mirrored on the peer's proxy client.\n\n```javascript\ninterlinked({\n  cells: {\n    within: {\n      cells: {\n        interlinked: () =\u003e 'interlinked'\n      }\n    }\n  }\n})\n\n// On a connected peer...\n\nremote.cells.within.cells.interlinked() // Promise resolve: 'interlinked'\n```\n\n### Errors\n\nErrors from remote observables or promises are caught and forwarded to the peer. Observables will complete with an error, and promises will be rejected, as you'd expect.\n\n```javascript\ninterlinked({\n  boom: () =\u003e { throw new Error('dreadfully distinct') }\n})\n\n// On a connected peer...\n\nremote.boom() // Promise reject: \u003cError message: 'dreadfully distinct'\u003e\n```\n\n## Middlewares\n\nInterlinked's types are implemented as [middlewares](src/middleware). An Interlinked middleware takes the form:\n\n```javascript\nfunction(input, output) {\n  return {\n    serve(key, value) {\n      // 1. setup necessary listeners on `input`\n      // 2. return a plain JavaScript object representing the value\n    },\n\n    proxy(serializedProperty) {\n      // return a proxy object that sends output and listens to input as necessary\n    }\n  }\n}\n```\n\n## Protocol\n\nBelow is a description of Interlinked's transfer protocol that you are responsible for serializing (JSON works fine) and sending over your transpor, e.g. a websocket.\n\n### Publishing the API\n\nA publish message is sent immediately when a peer connects.\n\n```javascript\n// Example API\n{\n  keypath: {\n    to: {\n      fn: () =\u003e {},\n      obs: of(1, 2, 3)\n    }\n  }\n}\n```\n\n```javascript\n// Result\n{\n  \"publish\": [\n    {\n      \"key\": \"keypath.to.fn\",\n      \"type\": \"function\"\n    },\n    {\n      \"key\": \"keypath.to.obs\",\n      \"type\": \"observable\"\n    }\n  ]\n}\n```\n\n### Functions\n\nThis format follows [JSON-RPC](http://www.jsonrpc.org), but this protocol is not intended to be a superset.\n\n| Operation | | Result |\n| --- | --- | --- |\n| `remote.path.to.fn('arg')` | → | `{ \"id\": txId, \"method\": \"path.to.fn\", \"params\": ['arg'] }` |\n| Successful response | ← | `{ \"id\": txId, \"result\": data }` |\n| Error response | ← | `{ \"id\": txId, \"error\": { \"message\": \"...\" } }` |\n\n`id` is a transaction ID established by the client.\n\n### Observables\n\n| Operation | | Result |\n| --- | --- | --- |\n| `remote.obs.subscribe()` | → | `[id, \"S\", \"obs\"]` |\n| New data | ← | `[id, \"N\", data]` |\n| Error | ← | `[id, \"E\", { message: \"...\" }]` |\n| Complete | ← | `[id, \"C\"]` |\n| Unsubscribe | → | `[id, \"U\"]` |\n\n`id` is a transaction ID established by the client.\n\n### Resources\n\nTBD\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrentd%2Finterlinked","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrentd%2Finterlinked","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrentd%2Finterlinked/lists"}