An open API service indexing awesome lists of open source software.

https://github.com/erkobridee/ts-definitions-common

useful typescript definitions
https://github.com/erkobridee/ts-definitions-common

commons definitions library npm-package rollup typescript

Last synced: 10 months ago
JSON representation

useful typescript definitions

Awesome Lists containing this project

README

          

[![Actions Status](https://github.com/erkobridee/ts-definitions-common/workflows/CD%20-%20publish%20docs%20and%20npm%20package/badge.svg)](https://github.com/erkobridee/ts-definitions-common/)

# typescript common definitions

⚠️  This library must be used as a dev dependency on a project that uses [TypeScript](https://www.typescriptlang.org/)

## Instalation

```
npm install --save-dev @erkobridee/ts-definitions-common
```

## Documentation

[@erkobridee/ts-definitions-common](http://erkobridee.github.io/ts-definitions-common/)

## Examples

[codesandbox example](https://codesandbox.io/s/hello-ts-definitions-common-lib-pjrql?file=/src/index.ts)

### TFunction

```javascript
import { TFunction } from '@erkobridee/ts-definitions-common';

// or

import { TFunction } from '@erkobridee/ts-definitions-common/types/functions';

const myFunction: TFunction = () => undefined;

const greetings: TFunction<[string], string> => value => `greetings ${value}!`;
```

### TDOMEventHandler

```javascript
import { TDOMEventHandler } from '@erkobridee/ts-definitions-common';

// or

import { TDOMEventHandler } from '@erkobridee/ts-definitions-common/types/dom';

const clickHandler: TDOMEventHandler = (event) => console.log(event);

window.addEventListener('click', clickHandler);
```