# @terra-dev/use-time-end

> Print the remain times

Latest version **0.20.1** (published 2021-07-15) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @terra-dev/use-time-end
pnpm add @terra-dev/use-time-end
yarn add @terra-dev/use-time-end
bun add @terra-dev/use-time-end
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.20.1 |
| Published | 2021-07-15 |
| First published | 2021-03-23 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=12 |
| Dependencies | 1 |
| Unpacked size | 15.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 99 |
| Author | Ian |
| Maintainers | ssen |

## Links

- npm: https://www.npmjs.com/package/@terra-dev/use-time-end
- Repository: https://github.com/Anchor-Protocol/anchor-web-app
- Homepage: https://github.com/Anchor-Protocol/anchor-web-app/tree/master/packages/src/@terra-dev/use-time-end
- Issues: https://github.com/Anchor-Protocol/anchor-web-app/issues
- npm.io page: https://npm.io/package/@terra-dev/use-time-end

## Dependencies (1)

- [@terra-dev/use-interval](https://npm.io/package/@terra-dev/use-interval.md) ^0.20.1

## Recent versions

- 0.20.1 (latest) — 2021-07-15
- 0.16.0-alpha.4 (canary) — 2021-06-13
- 0.20.0 — 2021-07-14
- 0.19.0 — 2021-07-09
- 0.18.0 — 2021-06-29
- 0.17.1 — 2021-06-28
- 0.17.0 — 2021-06-28
- 0.16.0 — 2021-06-21
- 0.16.0-alpha.3 — 2021-06-13
- 0.16.0-alpha.2 — 2021-06-13
- 0.16.0-alpha.1 — 2021-06-13
- 0.15.0 — 2021-06-01
- 0.14.0 — 2021-05-30
- 0.13.1 — 2021-05-15
- 0.13.0 — 2021-05-13
- … 15 more at https://npm.io/package/@terra-dev/use-time-end/versions

## README

# `@terra-dev/use-time-end`

Print the remain times

<https://anchor-storybook.vercel.app/?path=/story/packages-use-time-end--component>

## API

<!-- source index.ts --pick "timeGap useTimeEnd TimeEnd" -->

[index.ts](index.ts)

```ts
export function useTimeEnd(endTime: Date): string {}

export function TimeEnd({ endTime }: { endTime: Date }) {}

export const timeGap = (endTime: Date, now: Date) => {};
```

<!-- /source -->

## Spec

<!-- source __tests__/*.test.ts -->

[\_\_tests\_\_/use-time-end.test.ts](__tests__/use-time-end.test.ts)

```ts
import { timeGap } from '@terra-dev/use-time-end';

describe('use-time-end', () => {
  test('should get time gap', () => {
    const now = new Date(Date.parse('Thu, Feb 18 2020 00:00:00 GMT'));

    expect(
      timeGap(new Date(Date.parse('Wed, Feb 17 2020 18:30:00 GMT')), now),
    ).toBe('00:00:00');

    expect(
      timeGap(new Date(Date.parse('Thu, Feb 18 2020 00:00:30 GMT')), now),
    ).toBe('00:00:30');

    expect(
      timeGap(new Date(Date.parse('Thu, Feb 18 2020 00:30:30 GMT')), now),
    ).toBe('00:30:30');

    expect(
      timeGap(new Date(Date.parse('Thu, Feb 18 2020 10:30:30 GMT')), now),
    ).toBe('10:30:30');

    expect(
      timeGap(new Date(Date.parse('Thu, Feb 25 2020 10:30:30 GMT')), now),
    ).toBe('7 Days');
  });
});
```

<!-- /source -->

## Stories

<!-- source __stories__/*.stories.tsx -->

[\_\_stories\_\_/use-time-end.stories.tsx](__stories__/use-time-end.stories.tsx)

```tsx
import { DAY, HOUR, MINUTE, useTimeEnd, TimeEnd } from '../';

export default {
  title: 'packages/use-time-end',
};

export const Hook = () => {
  const p = useTimeEnd(new Date(Date.now() - DAY));
  const m30 = useTimeEnd(new Date(Date.now() + MINUTE * 30));
  const h2 = useTimeEnd(new Date(Date.now() + HOUR * 2));
  const d2 = useTimeEnd(new Date(Date.now() + DAY * 2));
  const d9 = useTimeEnd(new Date(Date.now() + DAY * 9));

  return (
    <ul>
      <li>{p}</li>
      <li>{m30}</li>
      <li>{h2}</li>
      <li>{d2}</li>
      <li>{d9}</li>
    </ul>
  );
};

export const Component = () => {
  return (
    <ul>
      <li>
        <TimeEnd endTime={new Date(Date.now() - DAY)} />
      </li>
      <li>
        <TimeEnd endTime={new Date(Date.now() + MINUTE * 30)} />
      </li>
      <li>
        <TimeEnd endTime={new Date(Date.now() + HOUR * 2)} />
      </li>
      <li>
        <TimeEnd endTime={new Date(Date.now() + DAY * 2)} />
      </li>
      <li>
        <TimeEnd endTime={new Date(Date.now() + DAY * 9)} />
      </li>
    </ul>
  );
};
```

<!-- /source -->

---
_Source: https://npm.io/package/@terra-dev/use-time-end · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
