JSPM – slice-text@0.0.0

Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (slice-text) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

A utility for slicing text based on search words, with support for overlapping matches and customizable matching patterns.

Features

🎯 Precise text slicing based on search words
🔄 Handles overlapping matches
⚡️ Customizable matching patterns
🎨 Case-sensitive/insensitive matching
📝 Clean and typed API (written in TypeScript)

Installation

yarn add slice-text
npm i slice-text
pnpm i slice-text

Usage

Basic Usage

import { sliceText } from 'slice-text'

const text = 'Hello hello world! How are you?'
const words = ['Hello', 'you']
const slices = sliceText(text, words) // Default matching pattern (case-insensitive)

console.log(slices)
// Output:
// [
//   { start: 0, end: 5, matched: true }, // 'Hello'
//   { start: 5, end: 6, matched: false }, // ' '
//   { start: 6, end: 11, matched: true }, // 'hello'
//   { start: 11, end: 27, matched: false }, // ' world! How are '
//   { start: 27, end: 30, matched: true }, // 'you'
//   { start: 30, end: 31, matched: false }, // '?'
// ]

Custom Matching Pattern

const text = 'HELLO Hello hello!'
const words = ['hello']
const match = (word: string) => new RegExp(word, 'g') // Case-sensitive matching
const result = sliceText(text, words, match)

console.log(result)
// Output:
// [
//   { start: 0, end: 12, matched: false }, // 'HELLO Hello 
//   { start: 12, end: 17, matched: true }, // 'hello'
//   { start: 17, end: 18, matched: false } // '!'
// ]

Building a Marked Output

const text = 'Hello world! How are you?'
const words = ['Hello', 'you']
const result = sliceText(text, words)
const markedText = slices.map(({ start, end, matched }) => {
  const segment = text.slice(start, end)
  return matched ? `<mark>${segment}</mark>` : segment
}).join('')
console.log(markedText)
// Output:
// '<mark>Hello</mark> <mark>world</mark>! How are you?'

API

`sliceText`

Processes text to find matches for search words and returns an array of slices with matched status.

export interface Slice {
  start: number
  end: number
  matched?: boolean
}

type Match = (word: string) => RegExp

interface Options {
  boundary?: boolean | 'start' | 'end'
  caseSensitive?: boolean
}

type OptionsOrMatch = Options | Match

function sliceText(text: string, words: string[], options?: OptionsOrMatch): Slice[]

`text`

Type: string The input text to be sliced

`words`

Type: string[] Array of words to search for

`options`

Type: OptionsOrMatch? Optional configuration object or match function:

If object: Configuration with boundary and case sensitivity options
If function: Custom matching function that returns a RegExp

Returns: Slice[] Array of slices representing matched positions in the text

slice-text