@kikiutils/types

A versatile library of utility types for TypeScript.

Features

• 📚 Comprehensive utility types for handling optional and nullable values
• 🧩 Seamless management of Vue component references

Installation

Add dependency (example using pnpm).

pnpm add -D @kikiutils/types

You can also use yarn, npm, or bun to add the dependency.

That's it! You're ready to use this package in your project. Check out the instructions for usage below ✨.

Usage

Import types in any .ts or .d.ts file under the project:

import type {} from '@kikiutils/types';
import type {} from '@kikiutils/types/type-fest';
import type {} from '@kikiutils/types/vue';

You can omit the import if the related types are not used.

[!IMPORTANT] Ensure the tsconfig.json settings include the file within the compiler's resolution scope.

All types are global and can be used throughout the project after import. Check out the instructions for types below.

Types

• index (main)

  • Dict
  • FilteredKeyPath - from filtered-key-path utility
  • Nullable
  • NullableNumber
  • NullableString
  • PartialDict
  • PartialRecord
  • Readonlyable
  • ReadonlyDict
  • ReadonlyRecord
  • Undefinedable
  • UndefinedableNumber
  • UndefinedableString

• type-fest

  • Arrayable
  • Except
  • Promisable

• vue

  • ComponentRef

License

MIT License