{"id":13672922,"url":"https://github.com/huruji/assets-preloader","last_synced_at":"2025-04-10T16:12:02.337Z","repository":{"id":34319226,"uuid":"177074830","full_name":"huruji/assets-preloader","owner":"huruji","description":"load web assets, like js, css, image, and return a promise","archived":false,"fork":false,"pushed_at":"2023-01-03T18:29:53.000Z","size":1529,"stargazers_count":7,"open_issues_count":12,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-24T14:01:34.138Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/huruji.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2019-03-22T05:07:56.000Z","updated_at":"2024-11-18T11:59:50.000Z","dependencies_parsed_at":"2023-01-15T06:30:42.604Z","dependency_job_id":null,"html_url":"https://github.com/huruji/assets-preloader","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huruji%2Fassets-preloader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huruji%2Fassets-preloader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huruji%2Fassets-preloader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huruji%2Fassets-preloader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/huruji","download_url":"https://codeload.github.com/huruji/assets-preloader/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248027409,"owners_count":21035594,"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-08-02T09:01:57.517Z","updated_at":"2025-04-10T16:12:02.317Z","avatar_url":"https://github.com/huruji.png","language":"TypeScript","readme":"\u003cp\u003e\n\u003cimg src=\"./logo.png\" width=\"300\"/\u003e\n\u003cp\u003e\n\n\n# assets-preloader\nload web assets, like js, css, image, and return a promise\n\n\u003e notice: assets-preloader only support image assets now, other assets will be as features in next version\n## example\n\n![](./preloader-example.gif)\n\nsee [Example](./example/README.md)\n\n## How to use\n\n```bash\nnpm i assets-preloader -S\n```\n\n```js\nimport Preloader from 'assets-preloader'\n\nconst imgs = [\n  // your imgs\n  // like 'http://assets-preload.io/logo.png'\n]\n\nconst loader = new Preloader(imgs)\n\nloader.listen('progress', (val) =\u003e {\n  // your code when progress events emited\n  // like: console.log(val)\n})\n\n// start load\nloader.load().then(() =\u003e {\n  // your code when all assets loaded\n  // like console.log('success')\n})\n```\n\n## Api\n\n`Preloader` is a class, so you need init an instance\n\n```js\nconst loader = new Preloader(assets)\n```\n### `.load`\n\nstart to load assets, it returns a `promise`\n\n```js\nloader.load().then(() =\u003e {\n  // your code\n})\n```\n\n### `.listen`\n\nlisten `progress` or `error` events\n\n```js\nloader.listen('progress', (val) =\u003e {\n  console.log(`Loading progress is ${val}`)\n})\n```\n\n### `.addEventListener`\n`alias` of `.listen`\n\n### `.add`\n\nadd asset to load\n\n```js\nloader.add('myasset.png')\n```\n## Events\n\n### progress\n\nEmited when asset loading completed, it's parameter is a progress number\n\n\n### error\n\nEmited when asset loading error, it's parameter is an `Error`\n\n\n**Listening event**: you can use `onprogress` or `listen` or `addEventListener`\n\n```js\nloader.listen('progress', (val) =\u003e {\n  // your code when progress events emited\n  // like: console.log(val)\n})\n\n// equal to\n\nloader.addEventListener('progress', (val) =\u003e {\n  // your code when progress events emited\n  // like: console.log(val)\n})\n\n// equal to\n\nloader.onprogress = (val) =\u003e {\n  // your code when progress events emited\n  // like: console.log(val)\n}\n```\n\n\n## How to build\n\n```js\nnpm run build\n```\n\n## How to release\n\n`assets-preloader` is using `standard-version`\n\n```bash\n# release as a major version\nnpm run release:major\n\n#release as a major version\nnpm run release:minor\n\n#release as a patch version\nnpm run release:patch\n\n```","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhuruji%2Fassets-preloader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhuruji%2Fassets-preloader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhuruji%2Fassets-preloader/lists"}