{"id":24130430,"url":"https://github.com/babyblue94520/ref","last_synced_at":"2025-09-04T02:32:48.140Z","repository":{"id":63299277,"uuid":"566818451","full_name":"babyblue94520/ref","owner":"babyblue94520","description":"Create a reference object that can be monitored.","archived":false,"fork":false,"pushed_at":"2024-01-12T02:50:38.000Z","size":146,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-02T14:22:39.717Z","etag":null,"topics":["computed","data-driven","ref","rxjs"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/babyblue94520.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-16T13:41:49.000Z","updated_at":"2023-01-21T09:09:29.000Z","dependencies_parsed_at":"2025-01-11T20:34:02.096Z","dependency_job_id":"c8440c0d-ac75-4e2f-9a34-acfb896ad481","html_url":"https://github.com/babyblue94520/ref","commit_stats":{"total_commits":13,"total_committers":2,"mean_commits":6.5,"dds":0.3846153846153846,"last_synced_commit":"5a43f6a6fa7abecd764456cf1dfc2da788fab57d"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/babyblue94520/ref","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/babyblue94520%2Fref","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/babyblue94520%2Fref/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/babyblue94520%2Fref/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/babyblue94520%2Fref/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/babyblue94520","download_url":"https://codeload.github.com/babyblue94520/ref/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/babyblue94520%2Fref/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259689938,"owners_count":22896739,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["computed","data-driven","ref","rxjs"],"created_at":"2025-01-11T20:33:52.463Z","updated_at":"2025-06-13T17:37:38.234Z","avatar_url":"https://github.com/babyblue94520.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ref\n\nCreate a reference object that can be monitored.\n\n[npm](https://www.npmjs.com/package/ts-refs)\n\n\n## Browser support\n\n| Chrome | Edge | Firefox | Opera | Safari | Chrome Android | Firefox for Android | Opera Android | Safari on iOS | Samsung Internet | WebView Android | Deno | Node.js |\n| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |\n| 1 | 12 | 1.5 | 9.5 | 3 | 18 | 4 | 10.1 | 1 | 1.0 | 37 | 1.0 | 0.10.0\n\n\n## Install\n\n```cmd\nnpm i ts-refs\n```\n\n\n\n## Usage\n\n### Refs\n\n* Create\n\n    * typescript\n\n        ```typescript\n        import Refs from \"ts-refs\";\n\n        const refs = new Refs();\n\n        // Set cache storage.\n        refs.setLocalStorage(localStorage);\n        refs.setSessionStorage(sessionStorage);\n        ```\n    * javascript\n\n        [ref.min.js](lib/ref.min.js)\n\n        ```html\n        \u003cscript type=\"application/javascript\" src=\"ref.min.js\"\u003e\u003c/script\u003e\n        \u003cscript type=\"application/javascript\"\u003e\n\n            var refs = new RefModule.default();\n\n            // Set cache storage.\n            refs.setLocalStorage(localStorage);\n            refs.setSessionStorage(sessionStorage);\n        \u003c/script\u003e\n        ```\n\n### Value Ref\n\n* Create\n\n    ```typescript\n    const valueRef = refs.of(0); // RefValue\u003cnumber\u003e\n    ```\n\n* get\n\n    ```typescript\n    valueRef.get(); // 0\n    ```\n    \n* set\n\n    ```typescript\n    valueRef.set(1);\n    ```\n\n* listen\n\n    ```typescript\n    valueRef.listen((value)=\u003e{\n        // TODO\n    },this);\n    ```\n\n* interrupt\n    Interrupt `Ref` listen by target.\n    ```typescript\n    valueRef.interrupt(this);\n    ```\n\n* clear\n\n    Reset to default value.\n    ```typescript\n    valueRef.clear();\n    ```\n\n### Computed Ref\n\nSave the computed results. Recompute when `Ref` changes.\n\n* Create\n\n    ```typescript\n    const valueRef = refs.of(0); \n    const computedRef = refs.ofComputed(()=\u003e{\n        return valueRef.get()+1;\n    }); // RefComputed\u003cnumber\u003e\n    ```\n\n* get\n    \n    Changed by dependent on other `Ref`.\n\n    ```typescript\n    computedRef.get(); // 0+1\n    ```\n\n* listen\n\n    Change by o\n\n    ```typescript\n    computedRef.listen((value)=\u003e{\n        // TODO\n    },this);\n    ```\n\n* interrupt\n    Interrupt ref listen by target.\n    ```typescript\n    computedRef.interrupt(this);\n    ```\n\n* clear\n\n    Clear computed results.\n    ```typescript\n    computedRef.clear();\n    ```\n\n### Cache Ref\n\nCache the last value in storage.\n\n* Create\n\n    ```typescript\n    const valueRef = refs.ofCache({\n        name:'string'\n        , local:false // switch storage type\n        , value: 0\n    }); // RefCache\u003cnumber\u003e\n    ```\n\n* get\n\n    ```typescript\n    valueRef.get(); // 0\n    ```\n    \n* set\n\n    ```typescript\n    valueRef.set(1);\n    ```\n\n* listen\n\n    ```typescript\n    valueRef.listen((value)=\u003e{\n        // TODO\n    },this);\n    ```\n\n* interrupt\n    Interrupt `Ref` listen by target.\n    ```typescript\n    valueRef.interrupt(this);\n    ```\n\n* clear\n\n    Reset to default value.\n    ```typescript\n    valueRef.clear();\n    ```\n\n## Advanced\n\n\n### Refs\n\n* off\n\n    Remove all dependencies and listener by scope.\n\n    ```typescript\n    refs.off(this);\n    ```\n\n* runInScope\n\n    ```typescript\n    let a = {};\n    refs.runInScope(()=\u003e{\n        // The default scope for all operations is `a`.\n        ref1.listen(()=\u003e{});\n        ref2.listen(()=\u003e{});\n        ref3.listen(()=\u003e{});\n    },a);\n    ```\n* tx\n\n    Post notifications after processing all `Ref` updates.\n\n    ```typescript\n    refs.tx(()=\u003e{\n        ref1.set(...)\n        ref2.set(...)\n        ref3.set(...)\n    });\n    ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbabyblue94520%2Fref","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbabyblue94520%2Fref","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbabyblue94520%2Fref/lists"}