Socket
Book a DemoInstallSign in
Socket

chunk-string

Package Overview
Dependencies
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

chunk-string

Split a string into smaller chunks

latest
Source
npmnpm
Version
1.1.0
Version published
Maintainers
1
Created
Source

chunk-string

Split a string into smaller strings, splits on whitespace where possible.

import { chunkString } from "chunk-string";

const example = "Lorem ipsum dolor sit amet, consectetur adipiscing elit"
const maxWordLength = 15;

const chunks = chunkString(example, maxWordLength);
const expectedOutput = [
  'Lorem ipsum',
  'dolor sit amet,',
  'consectetur',
  'adipiscing elit'
];

console.log(chunks, expectedOutput);

Prefix

There is support for automatically adding a prefix to each chunk using a function. There are several included examples;

  • count
  • markdownCount
import { chunkString, markdownCountPrefix } from "chunk-string";

const example = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
const maxWordLength = 50;

const chunks = chunkString(example, maxWordLength, markdownCountPrefix);
const expectedOutput = [
  '**_(1/4)_** Lorem ipsum dolor sit amet,',
  '**_(2/4)_** consectetur adipiscing elit, sed do',
  '**_(3/4)_** eiusmod tempor incididunt ut labore',
  '**_(4/4)_** et dolore magna aliqua.'
];

console.log(chunks, expectedOutput);

FAQs

Package last updated on 21 Nov 2023

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

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.