{"id":20715383,"url":"https://github.com/codler/utils","last_synced_at":"2025-03-11T07:17:32.506Z","repository":{"id":57103308,"uuid":"277644751","full_name":"codler/utils","owner":"codler","description":"https://www.npmjs.com/package/@codler/utils","archived":false,"fork":false,"pushed_at":"2021-10-31T15:28:25.000Z","size":150,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-05-02T00:31:13.345Z","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/codler.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":"2020-07-06T20:42:59.000Z","updated_at":"2021-10-31T15:26:40.000Z","dependencies_parsed_at":"2022-08-20T20:10:21.842Z","dependency_job_id":null,"html_url":"https://github.com/codler/utils","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codler%2Futils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codler%2Futils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codler%2Futils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codler%2Futils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codler","download_url":"https://codeload.github.com/codler/utils/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242988057,"owners_count":20217539,"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-17T02:38:18.057Z","updated_at":"2025-03-11T07:17:32.440Z","avatar_url":"https://github.com/codler.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @codler/utils\n\n## Install\n\n```bash\nnpm i @codler/utils\n```\n\n## Reference\n\n#### adBlock\n\n```js\nimport { adBlock } from \"@codler/utils\";\nawait adBlock.checkIsEnabled();\nadBlock.isEnabled();\n```\n\n| Method         | Notes              |\n| -------------- | ------------------ |\n| checkIsEnabled | `Promise\u003cboolean\u003e` |\n| isEnabled      | `boolean`          |\n\n#### color\n\n```js\nimport { color } from \"@codler/utils\";\ncolor.linear(value, maxValue);\ncolor.scaled(value, maxValue);\n```\n\n| Method | Notes                                         |\n| ------ | --------------------------------------------- |\n| linear | `(value: number, maxValue: number): hexColor` |\n| scaled | `(value: number, maxValue: number): hexColor` |\n\n#### date\n\n```js\nimport { date } from \"@codler/utils\";\ndate.format(new Date()); // 2020-01-01\ndate.today; // 2020-01-01\ndate.yesterday; // 2020-01-01\ndate.oneWeekAgo; // 2020-01-01\ndate.oneMonthAgo; // 2020-01-01\ndate.getWeek(new Date()); // { year: 2020, week: 1 }\ndate.getMondayFromWeek({ year: 2020, week: 1 }); // Date object\ndate.getSundayFromWeek({ year: 2020, week: 1 }); // Date object\n```\n\n| Method            | Notes                                          |\n| ----------------- | ---------------------------------------------- |\n| format            | `(date: Date) =\u003e YYYY-MM-DD`                   |\n| today             | `YYYY-MM-DD`                                   |\n| yesterday         | `YYYY-MM-DD`                                   |\n| oneWeekAgo        | `YYYY-MM-DD`                                   |\n| oneMonthAgo       | `YYYY-MM-DD`                                   |\n| getWeek           | `(date: Date): { year: number; week: number }` |\n| getMondayFromWeek | `({ year: number; week: number }): Date`       |\n| getSundayFromWeek | `({ year: number; week: number }): Date`       |\n\n#### debounce\n\n```js\nimport { debounce } from \"@codler/utils\";\ndebounce(() =\u003e void, 100);\n```\n\n| Parameter | Notes      |\n| --------- | ---------- |\n| func      | `function` |\n| wait      | `number`   |\n\n#### platform\n\n```js\nimport { platform } from \"@codler/utils\";\nplatform.isIos();\nplatform.isAndroid();\n```\n\n| Method    | Notes     |\n| --------- | --------- |\n| isIos     | `boolean` |\n| isAndroid | `boolean` |\n\n#### scrollToElement\n\n```js\nimport { scrollTo, scrollToElement, easing } from \"@codler/utils\";\n// ...\n```\n\n| Method          | Notes                                                                                  |\n| --------------- | -------------------------------------------------------------------------------------- |\n| scrollTo        | `(targetPosition: number, scrollDistance: number, duration: number, easing: Function)` |\n| scrollToElement | `(node: HTMLElement, duration: number, easing: Function)`                              |\n| easing          | `{easeInQuad}`                                                                         |\n\n### React Hooks\n\n#### useAsyncStorage\n\n```js\nimport { useAsyncStorage } from \"@codler/utils\";\nconst [get, set, isInit] = useAsyncStorage \u003c T \u003e (key, initialValue);\n```\n\n| Variable | Notes      |\n| -------- | ---------- |\n| get      | `T`        |\n| set      | `function` |\n| isInit   | `boolean`  |\n\n#### useInViewport\n\n```js\nimport { useInViewport } from \"@codler/utils\";\nconst { isVisible, update } = useInViewport();\n```\n\n| Variable  | Notes      |\n| --------- | ---------- |\n| isVisible | `boolean`  |\n| update    | `function` |\n\n#### useLocalStorage\n\n```js\nimport { useLocalStorage } from \"@codler/utils\";\nconst [get, set] = useLocalStorage \u003c T \u003e (key, initialValue);\n```\n\n| Variable | Notes      |\n| -------- | ---------- |\n| get      | `T`        |\n| set      | `function` |\n\n#### useWindowSize\n\n```js\nimport { useWindowSize } from \"@codler/utils\";\nconst { width, height } = useWindowSize();\n```\n\n| Variable | Notes    |\n| -------- | -------- |\n| width    | `number` |\n| height   | `number` |\n\n## Maintainer\n\n[Han Lin Yap](https://github.com/codler)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodler%2Futils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodler%2Futils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodler%2Futils/lists"}