{"id":21352565,"url":"https://github.com/ostark/cache-holepuncher","last_synced_at":"2025-03-16T04:43:44.847Z","repository":{"id":57192440,"uuid":"161327378","full_name":"ostark/cache-holepuncher","owner":"ostark","description":"A toolkit for pulling dynamic snippets in fully cached sites, a technique called Cache Hole Punching","archived":false,"fork":false,"pushed_at":"2018-12-30T01:35:19.000Z","size":36,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-23T02:38:45.175Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/ostark.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-11T12:00:30.000Z","updated_at":"2020-12-29T18:12:10.000Z","dependencies_parsed_at":"2022-08-24T03:10:31.236Z","dependency_job_id":null,"html_url":"https://github.com/ostark/cache-holepuncher","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ostark%2Fcache-holepuncher","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ostark%2Fcache-holepuncher/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ostark%2Fcache-holepuncher/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ostark%2Fcache-holepuncher/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ostark","download_url":"https://codeload.github.com/ostark/cache-holepuncher/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243826778,"owners_count":20354220,"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":[],"created_at":"2024-11-22T03:14:07.993Z","updated_at":"2025-03-16T04:43:44.825Z","avatar_url":"https://github.com/ostark.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cache-holepuncher.js\n\nA lightweight dependency-free library for cache hole punching. \n\nPull dynamic HMTL snippets in fully cached sites with a single line of code. By default the response is cached browser to avoid unnecessary requests. \n\n\n## Install\n\n```bash\nnpm install cache-holepuncher\n```\n\nor\n\n```bash\nyarn add cache-holepuncher\n```\n\nIf you are constained to a non-module environment (e.g. no bundlers such as webpack), pull the latest version of `cache-holepuncher` from `jsdelivr`.\n\n```html\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/cache-holepuncher@0.6.0/dist/holepuncher.min.js\"\u003e\u003c/script\u003e\n```\n\n\n\n## Basic usage\n\n...\n\n### Get single\n```html\n\u003cdiv id=\"single_placeholder_id\"\u003e\n    empty state\n\u003c/div\u003e\n\n\u003cscript\u003e\n    punch_one(\"/some/endpoint\", \"single_placeholder_id\");\n\u003c/script\u003e\n```\n\n### Get multiple\n```html\n\u003cul\u003e\n    \u003cli class=\"placeholder\" data-callback-url=\"/some/endpoint/foo\"\u003eempty state\u003c/li\u003e\n    \u003cli class=\"placeholder\" data-callback-url=\"/some/endpoint/bar\"\u003eempty state\u003c/li\u003e\n\u003c/ul\u003e\n\n\u003cscript\u003e\n    punch_all(\".placeholder\", \"data-callback-url\");\n\u003c/script\u003e\n```\n\n### Flush local cache\n```js\ndocument.querySelector(\"form\").addEventListener('submit', e =\u003e punch_flush());\n```\n\n## Advanced usage\n\n```js\nimport { HolePuncher } from './holepuncher';\n\nlet puncher     = new HolePuncher(options);\nlet placeholder = document.getElementById(elementId);\nlet url         = '/some/endpoint';\n    \n// do something before fetch  \npuncher.events.on('before_fetch', e =\u003e { \n    const placeholder = e.detail.context;\n    placeholder.classList.add('loading');\n});\n\n// do something when the data is avaiable\npuncher.events.on('fetch_data', e =\u003e { \n    // hide loader \n    const placeholder = e.detail.context;\n    const response = e.detail.response.clone();\n    response.json().then(data =\u003e {\n        placeholder.innerHTML = data.someAttribute;\n        placeholder.classList.remove('loading');\n        console.log(data.anotherAttribute)\n    }); \n});\n    \n// fetch html    \npuncher.fetch(url, placeholder);   \n\n// fetch json    \npuncher.fetch(url, placeholder, { \n    credentials: 'same-origin',\n    headers: new Headers({\n        'Content-Type': 'application/json'\n    })\n});      \n        \n// register listener that flushes the local cache \ndocument.querySelector(\"form\").addEventListener('submit', e =\u003e {\n    puncher.flush({verbose: true})\n});\n    \n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fostark%2Fcache-holepuncher","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fostark%2Fcache-holepuncher","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fostark%2Fcache-holepuncher/lists"}