{"library":"micromark-util-chunked","title":"Micromark Utility for Chunked Array Operations","description":"micromark-util-chunked is a specialized utility package within the `micromark` ecosystem, designed to perform array manipulations (`push` and `splice`) efficiently when dealing with exceptionally large arrays. Its primary purpose is to circumvent performance bottlenecks and V8 engine limitations, such as stack overflows, that can occur with native `Array.prototype.splice` when a massive number of items are involved. The current stable version is `2.0.1` (though the micromark monorepo has related packages at `4.x.x`). As part of the `micromark` monorepo, its updates typically align with the broader `micromark` project's active release schedule. A key differentiator is its optimized algorithms for chunked operations, ensuring stability and performance for complex parsing tasks often encountered within markdown processing. The package is ESM-only and ships with full TypeScript type definitions.","language":"javascript","status":"active","last_verified":"Sun Apr 19","install":{"commands":["npm install micromark-util-chunked"],"cli":null},"imports":["import { push } from 'micromark-util-chunked'","import { splice } from 'micromark-util-chunked'","import { push, splice } from 'micromark-util-chunked'"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"import { push, splice } from 'micromark-util-chunked';\n\n// Simulate a context object often used in micromark tokenizers\nconst context = { document: 'Some markdown string with lots of tokens...' };\n\n// Initialize an array of \"events\" (e.g., tokens or state changes).\n// Start with a moderately large array to demonstrate the utility's purpose.\nlet events: Array<[string, any, typeof context]> = [];\n\n// Populate with some initial data using `push`\nfor (let i = 0; i < 5000; i++) {\n  events = push(events, [['text', { type: 'text', value: `item-${i}` }, context]]);\n}\n\nconsole.log(`Initial events length: ${events.length}`);\n// Expected output: Initial events length: 5000\n\n// Demonstrate `push` with a large chunk of new items, which avoids V8 stack limits\nconst newItemsToAdd: Array<[string, any, typeof context]> = [];\nfor (let i = 0; i < 10000; i++) {\n  newItemsToAdd.push(['token', { type: 'new_token', value: `added-${i}` }, context]);\n}\nevents = push(events, newItemsToAdd);\nconsole.log(`Length after large push: ${events.length}`);\n// Expected output: Length after large push: 15000\n\n// Demonstrate `splice`: removing existing items and inserting new ones.\n// Let's remove 500 items from index 1000 and insert 2000 new ones.\nconst itemsToInsert: Array<[string, any, typeof context]> = [];\nfor (let i = 0; i < 2000; i++) {\n  itemsToInsert.push(['insert', { type: 'inserted', value: `inserted-${i}` }, context]);\n}\n\nconst startIndex = 1000;\nconst itemsToRemove = 500;\nsplice(events, startIndex, itemsToRemove, itemsToInsert);\nconsole.log(`Length after splice: ${events.length}`);\n// Expected output: Length after splice: 16500 (15000 - 500 + 2000)\n\n// Verify a few items around the spliced area\nconsole.log('Item before splice start:', events[startIndex - 1]);\nconsole.log('First inserted item:', events[startIndex]);\nconsole.log('Last inserted item:', events[startIndex + itemsToInsert.length - 1]);\nconsole.log('Item after inserted block:', events[startIndex + itemsToInsert.length]);\n\n// Example of a small final push\nevents = push(events, [['final', { type: 'end' }, context]]);\nconsole.log(`Length after final push: ${events.length}`);\n// Expected output: Length after final push: 16501\n","lang":"typescript","description":"This quickstart demonstrates how to use `push` and `splice` from `micromark-util-chunked` to efficiently manage large arrays of 'events' (e.g., markdown tokens), avoiding V8 limitations.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}