Socket
Socket
Sign inDemoInstall

knitwork

Package Overview
Dependencies
Maintainers
2
Versions
9
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

knitwork

Utilities to generate JavaScript code.


Version published
Weekly downloads
530K
decreased by-15.43%
Maintainers
2
Weekly downloads
 
Created
Source

🧶 knitwork

npm version npm downloads codecov

Utilities to generate JavaScript code.

Install

# ✨ Auto-detect
npx nypm install knitwork

# npm
npm install knitwork

# yarn
yarn add knitwork

# pnpm
pnpm install knitwork

# bun
bun install knitwork

ESM (Node.js, Bun)

import {} from "knitwork";

CommonJS (Legacy Node.js)

const {} = require("knitwork");

CDN (Deno, Bun and Browsers)

import {} from "https://esm.sh/knitwork";

ESM

genDynamicImport(specifier, options)

Generate an ESM dynamic import() statement.

genExport(specifier, exports?, options)

Generate an ESM export statement.

genImport(specifier, imports?, options)

Generate an ESM import statement.

Example:

genImport("pkg", "foo");
// ~> `import foo from "pkg";`

genImport("pkg", ["foo"]);
// ~> `import { foo } from "pkg";`

genImport("pkg", ["a", "b"]);
// ~> `import { a, b } from "pkg`;

genImport("pkg", [{ name: "default", as: "bar" }]);
// ~> `import { default as bar } from "pkg`;

genImport("pkg", [{ name: "foo", as: "bar" }]);
// ~> `import { foo as bar } from "pkg`;

genImport("pkg", "foo", { attributes: { type: "json" } });
// ~> `import foo from "pkg" with { type: "json" };

genExport("pkg", "foo");
// ~> `export foo from "pkg";`

genExport("pkg", ["a", "b"]);
// ~> `export { a, b } from "pkg";`

// export * as bar from "pkg"
genExport("pkg", { name: "*", as: "bar" });
// ~> `export * as bar from "pkg";`

genTypeImport(specifier, imports, options)

Generate an ESM import type statement.

Serialization

genArrayFromRaw(array, indent, options)

Serialize an array to a string.

Example:

genArrayFromRaw([1, 2, 3])
// ~> `[1, 2, 3]`

genObjectFromRaw(object, indent, options)

Serialize an object to a string.

Example:

genObjectFromValues({ foo: "bar", test: '() => import("pkg")' })
// ~> `{ foo: bar, test: () => import("pkg") }`

genObjectFromRawEntries(array, indent, options)

Serialize an array of key-value pairs to a string.

genObjectFromValues(obj, indent, options)

Serialize an object to a string.

Example:

genObjectFromValues({ foo: "bar" })
// ~> `{ foo: "bar" }`

String

escapeString(id)

Escape a string for use in a javascript string.

genSafeVariableName(name)

Generate a safe javascript variable name.

genString(input, options)

Generate a string with double or single quotes and handle escapes.

Typescript

genAugmentation(specifier)

Generate typescript declare module augmentation.

genInlineTypeImport(specifier, name, options)

Generate an typescript typeof import() statement for default import.

genInterface(name, contents?, options, indent)

Generate typescript interface.

genTypeExport(specifier, imports, options)

Generate a typescript export type statement.

genTypeObject(object, indent)

Generate typescript object type.

Contribution

Local development
  • Clone this repository
  • Install the latest LTS version of Node.js
  • Enable Corepack using corepack enable
  • Install dependencies using bun install
  • Run tests using bun dev

License

Published under the MIT license. Made by @pi0, @danielroe and community 💛


🤖 auto updated with automd

FAQs

Package last updated on 30 Mar 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc