@socketregistry/is-async-function - npm Package Compare versions

Comparing version 0.0.0 to 1.0.0

index.d.ts

+declare function isAsyncFunction(fn: unknown): boolean
+export = isAsyncFunction

index.js

+'use strict'
+
+const { toString: fnToStr } = Function.prototype
+const asyncFuncProto = Object.getPrototypeOf(async function () {})
+const { apply: ReflectApply, getPrototypeOf: ReflectGetPrototypeOf } = Reflect
+const { test: RegExpProtoTest } = RegExp.prototype
+// Source text of an async function, as `Function.prototype.toString` renders
+// it. Two shapes reach here: an arrow or method, `async (`, where the space is
+// optional; and a declaration or expression, `async function (`, where at
+// least one space separates the keywords and the name is optional. Alternation
+// branches are sorted alphanumerically (socket/sort-regex-alternations); the
+// order is behaviour-neutral because the two branches cannot both match, `\s*\(`
+// requires a paren where `\s+function` requires the keyword.
+const isFnRegExp = /^\s*async(?:\s*\(|\s+function(?:\(|\s+))/
+
+module.exports = function isAsyncFunction(fn) {
+  return (
+    typeof fn === 'function' &&
+    (ReflectApply(RegExpProtoTest, isFnRegExp, [
+      ReflectApply(fnToStr, fn, []),
+    ]) ||
+      ReflectGetPrototypeOf(fn) === asyncFuncProto)
+  )
+}

LICENSE

+MIT License
+
+Copyright (c) 2024 Socket Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package.json

 {
   "name": "@socketregistry/is-async-function",
-  "version": "0.0.0",
-  "private": false,
+  "version": "1.0.0",
+  "description": "Socket.dev optimized package override for is-async-function",
+  "keywords": [
+    "Socket.dev",
+    "package-overrides"
+  ],
+  "homepage": "https://github.com/SocketDev/socket-registry/tree/main/packages/npm/is-async-function",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/SocketDev/socket-registry.git",
+    "directory": "packages/npm/is-async-function"
+  },
+  "files": [
+    "*.d.ts",
+    "*.js"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.js"
+    },
+    "./package.json": "./package.json"
+  },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
-  "files": []
-}
+  "engines": {
+    "node": ">=24"
+  },
+  "socket": {
+    "categories": [
+      "cleanup"
+    ]
+  }
+}

README.md

 # @socketregistry/is-async-function
 
-Placeholder to reserve the name for npm trusted publishing. Real releases publish via CI (OIDC/provenance).
+[![Socket Badge](https://socket.dev/api/badge/npm/package/@socketregistry/is-async-function)](https://socket.dev/npm/package/@socketregistry/is-async-function)
+[![CI - @socketregistry/is-async-function](https://github.com/SocketDev/socket-registry/actions/workflows/ci.yml/badge.svg)](https://github.com/SocketDev/socket-registry/actions/workflows/ci.yml)
+
+[![Follow @SocketSecurity](https://img.shields.io/twitter/follow/SocketSecurity?style=social)](https://twitter.com/SocketSecurity)
+[![Follow @socket.dev on Bluesky](https://img.shields.io/badge/[e-mail]-1DA1F2?style=social&logo=bluesky)](https://bsky.app/profile/socket.dev)
+
+> A tested zero dependency drop-in replacement of [`is-async-function`](https://socket.dev/npm/package/is-async-function) complete with TypeScript types.
+
+## Installation
+
+### Install as a package override
+
+[`socket`](https://socket.dev/npm/package/socket)
+CLI will automagically ✨ populate
+[overrides](https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides)
+and [resolutions](https://yarnpkg.com/configuration/manifest#resolutions)
+of your `package.json`.
+
+```sh
+pnpm install -g socket@1.1.147
+socket optimize
+```
+
+Prefer to do it yourself? Add `@socketregistry/is-async-function`
+to your `package.json`.
+
+```json
+{
+  "overrides": {
+    "is-async-function": "npm:@socketregistry/is-async-function@^1"
+  },
+  "resolutions": {
+    "is-async-function": "npm:@socketregistry/is-async-function@^1"
+  }
+}
+```
+
+### Install as a plain dependency
+
+Install with your favorite package manager.
+
+```sh
+pnpm install @socketregistry/is-async-function
+```
+
+## Requirements
+
+Node >= `24`

Fixed alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

No License Found

License

License information could not be found.

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

No website

Quality

Package does not have a website.

Improved metrics

Total package byte prevSize

5874

1851.5%

Number of package files

6

200%

Number of low license alerts

0

-100%

Lines of code

24

Infinity%

Number of low quality alerts

1

-66.67%

Number of lines in readme file

51

1175%

Number of low supply chain risk alerts

0

-100%

Number of medium supply chain risk alerts

0

-100%

No dependency changes