init

dist/index.d.ts

@@ -1,2 +1 @@
-export { default as power } from "./sample";
-export { default as sqrt } from "./sample2";
+export { default as useCountdown } from './useCountdown';

dist/index.js

@@ -3,8 +3,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sqrt = exports.power = void 0;
-var sample_1 = require("./sample");
-Object.defineProperty(exports, "power", { enumerable: true, get: function () { return __importDefault(sample_1).default; } });
-var sample2_1 = require("./sample2");
-Object.defineProperty(exports, "sqrt", { enumerable: true, get: function () { return __importDefault(sample2_1).default; } });
+exports.useCountdown = void 0;
+var useCountdown_1 = require("./useCountdown");
+Object.defineProperty(exports, "useCountdown", { enumerable: true, get: function () { return __importDefault(useCountdown_1).default; } });

dist/sample.d.ts

@@ -1,2 +0,0 @@
-declare const power: (n?: number | undefined) => number | undefined;
-export default power;

dist/sample.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var power = function (n) {
-    if (typeof n === "undefined" || n === null) {
-        return undefined;
-    }
-    if (typeof n !== "number") {
-        return undefined;
-    }
-    return Math.pow(n, 2);
-};
-exports.default = power;

dist/sample2.d.ts

@@ -1,2 +0,0 @@
-declare const sqrt: (n: number) => number | undefined;
-export default sqrt;

dist/sample2.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var sqrt = function (n) {
-    if (typeof n === "undefined" || n === null) {
-        return undefined;
-    }
-    if (typeof n !== "number") {
-        return undefined;
-    }
-    return Math.sqrt(n);
-};
-exports.default = sqrt;

dist/useCountdown.d.ts

@@ -0,0 +1,12 @@
+interface useCountdownOptions {
+    now?: () => Date;
+    onEnd?: () => void;
+    onCount?: (timeLeft: number) => void;
+    step?: number;
+}
+interface CountdownHookResult {
+    timeleft: number;
+    start: (timeLeft: number) => void;
+}
+declare function useCountdown(options?: useCountdownOptions): CountdownHookResult;
+export default useCountdown;

dist/useCountdown.js

@@ -0,0 +1,54 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var react_1 = __importDefault(require("react"));
+var DEFAULT_OPTIONS = {
+    step: 1000
+};
+function useCountdown(options) {
+    var _a = react_1.default.useState(), timeleft = _a[0], setTimeleft = _a[1];
+    var _b = react_1.default.useState(), targetDatetime = _b[0], setTargetDatetime = _b[1];
+    var _c = __assign(__assign({}, DEFAULT_OPTIONS), options), step = _c.step, onCount = _c.onCount, onEnd = _c.onEnd;
+    var start = function (countAsM) {
+        setTimeleft(countAsM);
+    };
+    var varTimeout = null;
+    react_1.default.useEffect(function () {
+        return function () { return clearTimeout(varTimeout); };
+    }, []);
+    react_1.default.useEffect(function () {
+        if (timeleft === undefined) {
+            return;
+        }
+        var newTimeleft = timeleft - step;
+        if (newTimeleft < 0) {
+            setTimeleft(0);
+            onEnd === null || onEnd === void 0 ? void 0 : onEnd();
+        }
+        else {
+            onCount === null || onCount === void 0 ? void 0 : onCount(timeleft);
+            varTimeout = setTimeout(function () {
+                setTimeleft(newTimeleft);
+            }, step);
+        }
+    }, [timeleft]);
+    var result = {
+        timeleft: timeleft || 0,
+        start: start
+    };
+    return result;
+}
+exports.default = useCountdown;

example/.gitignore

@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

example/README.md

@@ -0,0 +1,68 @@
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `yarn start`
+
+Runs the app in the development mode.<br />
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+The page will reload if you make edits.<br />
+You will also see any lint errors in the console.
+
+### `yarn test`
+
+Launches the test runner in the interactive watch mode.<br />
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `yarn build`
+
+Builds the app for production to the `build` folder.<br />
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.<br />
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `yarn eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+
+If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+
+You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+
+## Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).
+
+### Code Splitting
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
+
+### Analyzing the Bundle Size
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
+
+### Making a Progressive Web App
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
+
+### Advanced Configuration
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
+
+### Deployment
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
+
+### `yarn build` fails to minify
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

example/index.js

@@ -1,12 +0,0 @@
-const { sqrt, power } = require("lib-name")
-
-console.log("Example Power : ")
-console.log("==========================")
-console.log("Result of 2 = ", power(2))
-console.log("Result of 4 = ", power(4))
-
-
-console.log("Example Sqrt : ")
-console.log("==========================")
-console.log("Result of 4 = ", sqrt(4))
-console.log("Result of 100 = ", sqrt(100))

example/package.json

@@ -1,14 +1,35 @@
 {
-  "name": "lib-example",
-  "version": "1.0.0",
-  "description": "Example of Develop Library",
-  "main": "index.js",
-  "license": "MIT",
-  "private": false,
+  "name": "example",
+  "version": "0.1.0",
+  "private": true,
   "dependencies": {
-    "lib-name": "link:../"
+    "@testing-library/jest-dom": "^4.2.4",
+    "@testing-library/react": "^9.3.2",
+    "@testing-library/user-event": "^7.1.2",
+    "cubetiq-react-use-countdown": "link:../",
+    "react": "^16.13.1",
+    "react-dom": "^16.13.1",
+    "react-scripts": "3.4.3"
   },
   "scripts": {
-    "start": "node index.js"
+    "start": "react-scripts start",
+    "build": "react-scripts build",
+    "test": "react-scripts test",
+    "eject": "react-scripts eject"
+  },
+  "eslintConfig": {
+    "extends": "react-app"
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
   }
 }

example/public/index.html

@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    <meta
+      name="description"
+      content="Web site created using create-react-app"
+    />
+    <link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
+    <!--
+      manifest.json provides metadata used when your web app is installed on a
+      user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
+    -->
+    <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
+    <!--
+      Notice the use of %PUBLIC_URL% in the tags above.
+      It will be replaced with the URL of the `public` folder during the build.
+      Only files inside the `public` folder can be referenced from the HTML.
+
+      Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
+      work correctly both with client-side routing and a non-root public URL.
+      Learn how to configure a non-root public URL by running `npm run build`.
+    -->
+    <title>React App</title>
+  </head>
+  <body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="root"></div>
+    <!--
+      This HTML file is a template.
+      If you open it directly in the browser, you will see an empty page.
+
+      You can add webfonts, meta tags, or analytics to this file.
+      The build step will place the bundled scripts into the <body> tag.
+
+      To begin the development, run `npm start` or `yarn start`.
+      To create a production bundle, use `npm run build` or `yarn build`.
+    -->
+  </body>
+</html>

example/public/manifest.json

@@ -0,0 +1,25 @@
+{
+  "short_name": "React App",
+  "name": "Create React App Sample",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/x-icon"
+    },
+    {
+      "src": "logo192.png",
+      "type": "image/png",
+      "sizes": "192x192"
+    },
+    {
+      "src": "logo512.png",
+      "type": "image/png",
+      "sizes": "512x512"
+    }
+  ],
+  "start_url": ".",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}

example/public/robots.txt

@@ -0,0 +1,3 @@
+# https://www.robotstxt.org/robotstxt.html
+User-agent: *
+Disallow:

example/src/index.js

@@ -0,0 +1,16 @@
+import React from "react"
+import ReactDOM from "react-dom"
+import { useCountdown} from "cubetiq-react-use-countdown"
+
+const App = () => {
+    const { timeleft , start } = useCountdown()
+	return (
+	<div>
+
+        <button onClick={() => start(10000)}>Start Count down </button>
+		<h1>Hellos Ciybt  {timeleft}</h1>
+	</div>
+)
+}
+
+ReactDOM.render(<App /> , document.querySelector("#root"))

init.sh

@@ -1,23 +0,0 @@
-# Remove Sample in src
-rm -rf src/sample*
-
-# Make src/index.ts Empty
-echo "" > src/index.ts
-
-# Remove Sample in Test
-rm -rf test/*
-
-# Remove Built
-rm -rf dist
-
-# Remove Example
-rm -rf example
-
-# Remove Self Init Script For Prevent Next time wrong on init
-rm -f ./init.sh
-
-# Reinit Git
-git init
-
-# Show Warning
-echo "Please Goto package.json and change Name , Description, Git Url of this library"

package.json

@@ -1,23 +1,26 @@
 {
-  "name": "lib-name",
+  "name": "cubetiq-react-use-countdown",
   "version": "1.0.0",
-  "description": "lib-description",
+  "description": "Count down with trigger",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "author": "SL",
   "license": "MIT",
   "private": false,
-  "keywords": ["javascript","typescript", "boilerplate","library"],
-
+  "keywords": [
+    "javascript",
+    "typescript",
+    "boilerplate",
+    "library"
+  ],
   "repository": {
     "url": "https://git.cubetiqs.com/s.long/js-lib-boilerplate"
   },
   "scripts": {
     "build": "tsc",
     "test": "jest",
-    "build:test": "yarn jest && yarn build",
+    "build:test": "yarn test && yarn build",
     "publish": "yarn build:test && npm publish --registry https://npm.osa.cubetiqs.com",
-
     "run:example": "cd example && yarn start"
   },
   "devDependencies": {
@@ -26,6 +29,7 @@
     "@babel/preset-typescript": "^7.10.4",
     "@types/jest": "^26.0.10",
     "@types/node": "^14.6.1",
+    "@types/react": "^16.9.49",
     "@typescript-eslint/eslint-plugin": "^3.10.1",
     "@typescript-eslint/parser": "^3.10.1",
     "babel-jest": "^26.3.0",

src/index.ts

@@ -1,5 +1 @@
-
-
-export { default as power } from "./sample"
-
-export { default as sqrt } from "./sample2"
+export { default as useCountdown } from './useCountdown';

src/sample.ts

@@ -1,11 +0,0 @@
-const power = (n? : number) : number | undefined => {
-    if( typeof n === "undefined" || n === null){
-        return  undefined
-    }
-    if(typeof n !== "number"){
-        return undefined
-    }
-    return Math.pow(n, 2)
-}
-
-export default power

src/sample2.ts

@@ -1,11 +0,0 @@
-const sqrt = (n : number): number | undefined => {
-    if( typeof n === "undefined" || n === null){
-        return  undefined
-    }
-    if(typeof n !== "number"){
-        return undefined
-    }
-    return Math.sqrt(n)
-}
-
-export default sqrt

src/useCountdown.ts

@@ -0,0 +1,65 @@
+import React from 'react';
+import Timeout = NodeJS.Timeout;
+
+interface useCountdownOptions {
+    now?: () => Date;
+    onEnd?: () => void;
+    onCount?: (timeLeft: number) => void;
+    step?: number; // Millisecond
+}
+
+interface CountdownHookResult {
+    timeleft: number;
+    start: (timeLeft: number) => void;
+}
+
+const DEFAULT_OPTIONS: useCountdownOptions = {
+    step: 1000,
+};
+
+function useCountdown(options?: useCountdownOptions): CountdownHookResult {
+    const [timeleft, setTimeleft] = React.useState<number | undefined>();
+
+    const [targetDatetime, setTargetDatetime] = React.useState<Date>();
+
+    const { step, onCount, onEnd } = {
+        ...DEFAULT_OPTIONS,
+        ...options,
+    };
+
+    const start = (countAsM: number) => {
+        setTimeleft(countAsM);
+    };
+    let varTimeout: number | null = null;
+
+    React.useEffect(() => {
+        return () => clearTimeout(varTimeout!);
+    }, []);
+
+    React.useEffect(() => {
+        if (timeleft === undefined) {
+            return;
+        }
+
+        const newTimeleft = timeleft - step!;
+
+        if (newTimeleft < 0) {
+            setTimeleft(0);
+            onEnd?.();
+        } else {
+            onCount?.(timeleft);
+            varTimeout = setTimeout(() => {
+                setTimeleft(newTimeleft);
+            }, step);
+        }
+    }, [timeleft]);
+
+    const result: CountdownHookResult = {
+        timeleft: timeleft || 0,
+        start,
+    };
+
+    return result;
+}
+
+export default useCountdown;

test/sample.test.js

@@ -1,25 +0,0 @@
-import {power} from "../src"
-
-// Describe : top level to describe a block of test below is for what
-describe("Test Sample Function", () => {
-    // Test : is run for each test
-    test("Test N is Undefined", () => {
-        expect(power(undefined)).toBe(undefined) // expect sample(undefined) return undefined
-    })
-
-    test("Test N is Null", () => {
-        expect(power(null)).toBe(undefined)
-    })
-
-    test("Test N is not number",() => {
-        expect(power("Hello")).toBe(undefined)
-    })
-
-    test("Test Normal Number",() => {
-        expect(power(0)).toBe(0)
-        expect(power(1)).toBe(1)
-        expect(power(2)).toBe(4)
-        expect(power(100)).toBe(10000)
-    })
-
-})

test/sample2.test.js

@@ -1,25 +0,0 @@
-import {sqrt} from "../src"
-
-// Describe : top level to describe a block of test below is for what
-describe("Test Sample 2 Function", () => {
-    // Test : is run for each test
-    test("Test N is Undefined", () => {
-        expect(sqrt(undefined)).toBe(undefined) // expect sample(undefined) return undefined
-    })
-
-    test("Test N is Null", () => {
-        expect(sqrt(null)).toBe(undefined)
-    })
-
-    test("Test N is not number",() => {
-        expect(sqrt("Hello")).toBe(undefined)
-    })
-
-    test("Test Normal Number",() => {
-        expect(sqrt(0)).toBe(0)
-        expect(sqrt(1)).toBe(1)
-        expect(sqrt(4)).toBe(2)
-        expect(sqrt(10000)).toBe(100)
-    })
-
-})