https://github.com/flex-development/tutils

TypeScript-friendly utilities
https://github.com/flex-development/tutils

enums interfaces type-definitions type-guards type-programming types typescript typescript-utilities

Last synced: 3 months ago
JSON representation

TypeScript-friendly utilities

• Host: GitHub
• URL: https://github.com/flex-development/tutils
• Owner: flex-development
• License: bsd-3-clause
• Created: 2021-05-21T00:10:24.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-23T01:23:25.000Z (about 1 year ago)
• Last Synced: 2024-10-22T16:23:25.349Z (7 months ago)
• Topics: enums, interfaces, type-definitions, type-guards, type-programming, types, typescript, typescript-utilities
• Language: TypeScript
• Homepage: https://github.com/flex-development/tutils
• Size: 9.43 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/funding.yml
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# tutils

[![github release](https://img.shields.io/github/v/release/flex-development/tutils.svg?include_prereleases)](https://github.com/flex-development/tutils/releases/latest)

[![npm](https://img.shields.io/npm/v/@flex-development/tutils.svg)](https://npmjs.com/package/@flex-development/tutils)

[![codecov](https://codecov.io/gh/flex-development/tutils/branch/main/graph/badge.svg?token=ZT857Z0ITA)](https://codecov.io/gh/flex-development/tutils)

[![module type: esm](https://img.shields.io/badge/module%20type-esm-brightgreen)](https://github.com/voxpelli/badges-cjs-esm)

[![license](https://img.shields.io/github/license/flex-development/tutils.svg)](LICENSE.md)

[![conventional commits](https://img.shields.io/badge/-conventional%20commits-fe5196?logo=conventional-commits&logoColor=ffffff)](https://conventionalcommits.org/)

[![typescript](https://img.shields.io/badge/-typescript-3178c6?logo=typescript&logoColor=ffffff)](https://typescriptlang.org/)

[![vitest](https://img.shields.io/badge/-vitest-6e9f18?style=flat&logo=vitest&logoColor=ffffff)](https://vitest.dev/)

[![yarn](https://img.shields.io/badge/-yarn-2c8ebb?style=flat&logo=yarn&logoColor=ffffff)](https://yarnpkg.com/)

[TypeScript][1]-friendly utilities.

## Contents

- [What is this?](#what-is-this)

- [When should I use this?](#when-should-i-use-this)

- [Install](#install)

- [Use](#use)

- [Related](#related)

## What is this?

This package contains a set of [TypeScript][1]-friendly utilities.

## When should I use this?

**TODO**: use cases

## Install

This package is [ESM only][2].

```sh

yarn add @flex-development/tutils

```

From Git:

```sh

yarn add @flex-development/tutils@flex-development/tutils

```



  

    See Git - Protocols | Yarn

     for details on requesting a specific branch, commit, or tag.

  



## Use

**TODO**: usage example

## Related

- [`esm-types`][3] - TypeScript definitions for [ECMAScript modules][4]

- [`pkg-types`][5] - TypeScript definitions for `package.json`

- [`tsconfig-types`][6] - TypeScript definitions for `tsconfig.json`

[1]: https://typescriptlang.org/

[2]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[3]: https://github.com/flex-development/esm-types

[4]: https://nodejs.org/api/esm.html

[5]: https://github.com/flex-development/pkg-types

[6]: https://github.com/flex-development/tsconfig-types