@hugoalh/is-special-type v0.1.3

Is Special Type (ES)

⚖️ MIT

An ES (JavaScript & TypeScript) module to determine whether the item is special/specific type:

• Async Function
• Async Generator Function
• Async Generator
• Sync Function
• Sync Generator Function
• Sync Generator

This only reports back what the JavaScript engine is seeing; In particular, the return value may not match the original source code if a transpilation tool was used.

🔰 Begin

🎯 Targets

ℹ️ Note

It is possible to use this module in other methods/ways which not listed in here, however it is not officially supported.

#️⃣ Registries Identifier

• JSR:

  @hugoalh/is-special-type

• NPM:

  @hugoalh/is-special-type

ℹ️ Note

• Although it is recommended to import the entire module, it is also able to import part of the module with sub path if available, please visit file jsr.jsonc property exports for available sub paths.
• It is recommended to use this module with tag for immutability.

#️⃣ Remote Import Paths

• GitHub Raw: (Require Tag)

  https://raw.githubusercontent.com/hugoalh-studio/is-special-type-es/${Tag}/mod.ts

ℹ️ Note

• Although it is recommended to import the entire module with the main path mod.ts, it is also able to import part of the module with sub path if available, but do not import if:

  • it's file path has an underscore prefix (e.g.: _foo.ts, _util/bar.ts), or
  • it is a benchmark or test file (e.g.: foo.bench.ts, foo.test.ts), or
  • it's symbol has an underscore prefix (e.g.: export function _baz() {}).

  These elements are not considered part of the public API, thus no stability is guaranteed for them.

• Although there have 3rd party services which provide enhanced, equal, or similar methods/ways to remote import the module, beware these services maybe inject unrelated elements and thus affect the security.

🛡️ Permissions

This module does not require any permission.

🧩 APIs

• function isAsyncFunction(item: unknown): item is (...parameters: unknown[]) => Promise<unknown>;

• function isAsyncGeneratorFunction(item: unknown): item is AsyncGeneratorFunction;

• function isAsyncGenerator(item: unknown): item is AsyncGenerator;

• function isSyncFunction(item: unknown): item is (...parameters: unknown[]) => Exclude<unknown, Promise<unknown>>;

• function isSyncGeneratorFunction(item: unknown): item is GeneratorFunction;

• function isSyncGenerator(item: unknown): item is Generator;

ℹ️ Note

For the prettier documentation, can visit via:

• Deno CLI deno doc
• JSR