Class TextBitByBit

Trabajar con texto: dividir, unir, buscar, recortar, rellenar, cambiar mayúsculas y minúsculas, expresiones regulares y formateo con marcadores de posición. vectorChar y vectorText convierten el texto en rutas de líneas dibujadas con una fuente de trazo simple, para que las palabras puedan convertirse en geometría. Las posiciones en el texto cuentan desde 0.

Index

Constructors

constructor

create

Constructors

constructor

new TextBitByBit(point: Bit.Point): TextBitByBit
Parameters
- point: Bit.Point
Returns TextBitByBit
- Defined in bitbybit-docs.d.ts:56537

create

create(inputs: Bit.Inputs.Text.TextDto): string
Deja pasar un texto sin cambios, de modo que a un valor se le puede dar un nombre y reutilizarlo.

Ejemplo: 'Hello World' -> 'Hello World'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  El texto
Returns string
El mismo texto
- Defined in bitbybit-docs.d.ts:56548

query

includes

includes(inputs: TextSearchDto): boolean
Indica si un texto contiene un texto buscado.

Ejemplo: 'hello world' incluye 'world' -> true
Parameters
- inputs: TextSearchDto
  El texto y qué buscar
Returns boolean
True cuando el texto buscado aparece en él
Example
```
const has = bitbybit.text.includes({ text: "hello world", search: "world" });
```
- Defined in bitbybit-docs.d.ts:56647

startsWith

startsWith(inputs: TextSearchDto): boolean
Indica si un texto empieza por un texto buscado.

Ejemplo: 'hello world' empieza por 'hello' -> true
Parameters
- inputs: TextSearchDto
  El texto y qué buscar en su inicio
Returns boolean
True cuando el texto empieza por él
Example
```
const starts = bitbybit.text.startsWith({ text: "hello world", search: "hello" });
```
- Defined in bitbybit-docs.d.ts:56662

endsWith

endsWith(inputs: TextSearchDto): boolean
Indica si un texto termina en un texto buscado.

Ejemplo: 'hello world' termina en 'world' -> true
Parameters
- inputs: TextSearchDto
  El texto y qué buscar en su final
Returns boolean
True cuando el texto termina por él
Example
```
const ends = bitbybit.text.endsWith({ text: "hello world", search: "world" });
```
- Defined in bitbybit-docs.d.ts:56677

indexOf

indexOf(inputs: TextSearchDto): number
Encuentra dónde aparece por primera vez un texto buscado, contando caracteres desde 0, o -1 cuando no aparece.

Ejemplo: 'hello world' buscando 'world' -> 6
Parameters
- inputs: TextSearchDto
  El texto y qué buscar
Returns number
La posición de la primera aparición, o -1
Example
```
const at = bitbybit.text.indexOf({ text: "hello world", search: "world" });
```
- Defined in bitbybit-docs.d.ts:56693

lastIndexOf

lastIndexOf(inputs: TextSearchDto): number
Encuentra dónde aparece por última vez un texto buscado, contando caracteres desde 0, o -1 cuando no aparece.

Ejemplo: 'hello world hello' buscando 'hello' -> 12
Parameters
- inputs: TextSearchDto
  El texto y qué buscar
Returns number
La posición de la última aparición, o -1
Example
```
const at = bitbybit.text.lastIndexOf({ text: "hello world hello", search: "hello" });
```
- Defined in bitbybit-docs.d.ts:56709

charAt

charAt(inputs: TextIndexDto): string
Lee el carácter en una posición, contando desde 0.

Ejemplo: 'hello' en 1 -> 'e'
Parameters
- inputs: TextIndexDto
  El texto y la posición
Returns string
El carácter, o un texto vacío cuando la posición está fuera del texto
Example
```
const second = bitbybit.text.charAt({ text: "hello", index: 1 });
```
- Defined in bitbybit-docs.d.ts:56756

length

length(inputs: Bit.Inputs.Text.TextDto): number
Cuenta los caracteres de un texto.

Ejemplo: 'hello' -> 5
Parameters
- inputs: Bit.Inputs.Text.TextDto
  El texto
Returns number
El número de caracteres
- Defined in bitbybit-docs.d.ts:56902

isEmpty

isEmpty(inputs: Bit.Inputs.Text.TextDto): boolean
Indica si un texto está vacío o contiene solo espacios en blanco.

Ejemplo: ' ' -> true, 'a' -> false
Parameters
- inputs: Bit.Inputs.Text.TextDto
  El texto
Returns boolean
True cuando no hay nada más que espacios en blanco
- Defined in bitbybit-docs.d.ts:56913

regex

regexTest

regexTest(inputs: TextRegexDto): boolean
Indica si una expresión regular coincide en algún lugar de un texto.

Ejemplo: 'hello123' contra '[0-9]+' -> true
Parameters
- inputs: TextRegexDto
  El texto, el patrón y los indicadores
Returns boolean
True cuando el patrón coincide
Example
```
const hasDigits = bitbybit.text.regexTest({ text: "hello123", pattern: "[0-9]+", flags: "" });
```
- Defined in bitbybit-docs.d.ts:56943

regexMatch

regexMatch(inputs: TextRegexDto): string[]
Encuentra las partes de un texto con las que coincide una expresión regular.

Con el indicador g se listan todas las coincidencias; sin él solo la primera coincidencia y sus grupos de captura. Sin coincidencia da null. Ejemplo: 'hello123world456' contra '[0-9]+' con 'g' -> ['123', '456']
Parameters
- inputs: TextRegexDto
  El texto, el patrón y los indicadores
Returns string[]
Las coincidencias, o null cuando no hay ninguna
Example
```
const numbers = bitbybit.text.regexMatch({ text: "hello123world456", pattern: "[0-9]+", flags: "g" });
```
- Defined in bitbybit-docs.d.ts:56960

regexReplace

regexReplace(inputs: TextRegexReplaceDto): string
Sustituye lo que coincide con una expresión regular por otro texto.

Con el indicador g se sustituyen todas las coincidencias; sin él solo la primera. Ejemplo: 'hello123world456' contra '[0-9]+' con 'g', sustituido por 'X' -> 'helloXworldX'
Parameters
- inputs: TextRegexReplaceDto
  El texto, el patrón, los indicadores y el reemplazo
Returns string
El texto con las sustituciones hechas
Example
```
const clean = bitbybit.text.regexReplace({ text: "hello123world456", pattern: "[0-9]+", flags: "g", replaceWith: "X" });
```
- Defined in bitbybit-docs.d.ts:56976

regexSearch

regexSearch(inputs: TextRegexDto): number
Encuentra dónde coincide por primera vez una expresión regular, contando caracteres desde 0, o -1 cuando no coincide.

Ejemplo: 'hello123' contra '[0-9]+' -> 5
Parameters
- inputs: TextRegexDto
  El texto, el patrón y los indicadores
Returns number
La posición de la primera coincidencia, o -1
Example
```
const at = bitbybit.text.regexSearch({ text: "hello123", pattern: "[0-9]+", flags: "" });
```
- Defined in bitbybit-docs.d.ts:56992

regexSplit

regexSplit(inputs: TextRegexDto): string[]
Corta un texto en trozos allí donde coincide una expresión regular; las coincidencias en sí se descartan.

Ejemplo: 'a1b2c3' dividido por '[0-9]+' -> ['a', 'b', 'c', '']
Parameters
- inputs: TextRegexDto
  El texto, el patrón y los indicadores
Returns string[]
Los trozos, en orden
Example
```
const letters = bitbybit.text.regexSplit({ text: "a1b2c3", pattern: "[0-9]+", flags: "" });
```
- Defined in bitbybit-docs.d.ts:57008

transform

split

split(inputs: TextSplitDto): string[]
Corta un texto en trozos allí donde aparece un separador; el separador en sí se descarta.

Ejemplo: 'apple,banana,cherry' dividido por ',' -> ['apple', 'banana', 'cherry']
Parameters
- inputs: TextSplitDto
  El texto y el separador
Returns string[]
Los trozos, en orden
Example
```
const parts = bitbybit.text.split({ text: "apple,banana,cherry", separator: "," });
```
- Defined in bitbybit-docs.d.ts:56563

replaceAll

replaceAll(inputs: TextReplaceDto): string
Sustituye cada aparición de un texto buscado por otro texto.

Ejemplo: 'hello hello' sustituyendo 'hello' por 'hi' -> 'hi hi'
Parameters
- inputs: TextReplaceDto
  El texto, qué buscar y qué poner en su lugar
Returns string
El texto con las sustituciones hechas
Example
```
const greeting = bitbybit.text.replaceAll({ text: "hello hello", search: "hello", replaceWith: "hi" });
```
- Defined in bitbybit-docs.d.ts:56578

join

join(inputs: TextJoinDto): string
Une una lista de textos en uno, con un separador entre vecinos.

Ejemplo: ['apple', 'banana', 'cherry'] unidos por ', ' -> 'apple, banana, cherry'
Parameters
- inputs: TextJoinDto
  Los textos y el separador
Returns string
El texto unido
Example
```
const line = bitbybit.text.join({ list: ["apple", "banana"], separator: ", " });
```
- Defined in bitbybit-docs.d.ts:56593

toString

toString<T>(inputs: ToStringDto<T>): string
Convierte cualquier valor en texto, tal como lo imprime JavaScript.

Ejemplo: 42 -> '42', [1, 2] -> '1,2'
Type Parameters
- T
Parameters
- inputs: ToStringDto<T>
  El valor
Returns string
El valor como texto
- Defined in bitbybit-docs.d.ts:56604

toStringEach

toStringEach<T>(inputs: ToStringEachDto<T>): string[]
Convierte cada elemento de una lista en texto, tal como lo imprime JavaScript.

Ejemplo: [1, 2.5, true] -> ['1', '2.5', 'true']
Type Parameters
- T
Parameters
- inputs: ToStringEachDto<T>
  La lista de valores
Returns string[]
Un texto por elemento, en orden
- Defined in bitbybit-docs.d.ts:56615

format

format(inputs: TextFormatDto): string
Rellena marcadores numerados de un texto con valores: {0} toma el primer valor, {1} el segundo, y así sucesivamente.

Un marcador sin valor se deja tal cual. Ejemplo: 'Point: ({0}, {1})' con [10, 5] -> 'Point: (10, 5)'
Parameters
- inputs: TextFormatDto
  El texto con marcadores de posición y los valores que rellenar
Returns string
El texto rellenado
Example
```
const label = bitbybit.text.format({ text: "Point: ({0}, {1})", values: ["10", "5"] });
```
- Defined in bitbybit-docs.d.ts:56632

substring

substring(inputs: TextSubstringDto): string
Toma los caracteres desde una posición inicial hasta una posición final, sin incluirla.

Un inicio mayor que el final intercambia los dos, y las posiciones negativas cuentan como 0. Ejemplo: 'hello world' de 0 a 5 -> 'hello'
Parameters
- inputs: TextSubstringDto
  El texto y las posiciones inicial y final
Returns string
Los caracteres de ese rango
Example
```
const word = bitbybit.text.substring({ text: "hello world", start: 0, end: 5 });
```
- Defined in bitbybit-docs.d.ts:56725

slice

slice(inputs: TextSubstringDto): string
Toma los caracteres desde una posición inicial hasta una posición final, sin incluirla.

A diferencia de substring, una posición negativa cuenta desde el final del texto. Ejemplo: 'hello world' de 0 a 5 -> 'hello'; desde -5 -> 'world'
Parameters
- inputs: TextSubstringDto
  El texto y las posiciones inicial y final
Returns string
Los caracteres de ese rango
Example
```
const tail = bitbybit.text.slice({ text: "hello world", start: 6, end: 11 });
```
- Defined in bitbybit-docs.d.ts:56741

trim

trim(inputs: Bit.Inputs.Text.TextDto): string
Elimina espacios, tabuladores y saltos de línea de ambos extremos de un texto.

Ejemplo: ' hello ' -> 'hello'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  El texto
Returns string
El texto recortado
- Defined in bitbybit-docs.d.ts:56767

trimStart

trimStart(inputs: Bit.Inputs.Text.TextDto): string
Elimina espacios, tabuladores y saltos de línea del principio de un texto.

Ejemplo: ' hello ' -> 'hello '
Parameters
- inputs: Bit.Inputs.Text.TextDto
  El texto
Returns string
El texto sin espacios en blanco iniciales
- Defined in bitbybit-docs.d.ts:56778

trimEnd

trimEnd(inputs: Bit.Inputs.Text.TextDto): string
Elimina espacios, tabuladores y saltos de línea del final de un texto.

Ejemplo: ' hello ' -> ' hello'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  El texto
Returns string
El texto sin espacios en blanco finales
- Defined in bitbybit-docs.d.ts:56789

padStart

padStart(inputs: TextPadDto): string
Añade un texto de relleno por delante hasta que el texto alcanza una longitud; un texto que ya tiene esa longitud se deja en paz.

Ejemplo: 'x' hasta la longitud 3 con 'a' -> 'aax'
Parameters
- inputs: TextPadDto
  El texto, la longitud que alcanzar y el relleno
Returns string
El texto rellenado
Example
```
const padded = bitbybit.text.padStart({ text: "7", length: 3, padString: "0" });
```
- Defined in bitbybit-docs.d.ts:56805

padEnd

padEnd(inputs: TextPadDto): string
Añade un texto de relleno por detrás hasta que el texto alcanza una longitud; un texto que ya tiene esa longitud se deja en paz.

Ejemplo: 'x' hasta la longitud 3 con 'a' -> 'xaa'
Parameters
- inputs: TextPadDto
  El texto, la longitud que alcanzar y el relleno
Returns string
El texto rellenado
Example
```
const padded = bitbybit.text.padEnd({ text: "x", length: 3, padString: "a" });
```
- Defined in bitbybit-docs.d.ts:56821

toUpperCase

toUpperCase(inputs: Bit.Inputs.Text.TextDto): string
Convierte cada letra en mayúscula.

Ejemplo: 'hello' -> 'HELLO'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  El texto
Returns string
El texto en mayúsculas
- Defined in bitbybit-docs.d.ts:56832

toLowerCase

toLowerCase(inputs: Bit.Inputs.Text.TextDto): string
Convierte cada letra en minúscula.

Ejemplo: 'HELLO' -> 'hello'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  El texto
Returns string
El texto en minúsculas
- Defined in bitbybit-docs.d.ts:56843

toUpperCaseFirst

toUpperCaseFirst(inputs: Bit.Inputs.Text.TextDto): string
Convierte el primer carácter en mayúscula y deja el resto como está.

Ejemplo: 'hello world' -> 'Hello world'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  El texto
Returns string
El texto con su primer carácter en mayúscula
- Defined in bitbybit-docs.d.ts:56854

toLowerCaseFirst

toLowerCaseFirst(inputs: Bit.Inputs.Text.TextDto): string
Convierte el primer carácter en minúscula y deja el resto como está.

Ejemplo: 'Hello World' -> 'hello World'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  El texto
Returns string
El texto con su primer carácter en minúscula
- Defined in bitbybit-docs.d.ts:56865

repeat

repeat(inputs: TextRepeatDto): string
Repite un texto un número de veces, uno tras otro.

Ejemplo: 'ha' tres veces -> 'hahaha'
Parameters
- inputs: TextRepeatDto
  El texto y cuántas veces repetirlo
Returns string
El texto repetido
Example
```
const laugh = bitbybit.text.repeat({ text: "ha", count: 3 });
```
- Defined in bitbybit-docs.d.ts:56880

reverse

reverse(inputs: Bit.Inputs.Text.TextDto): string
Invierte el orden de los caracteres.

Ejemplo: 'hello' -> 'olleh'
Parameters
- inputs: Bit.Inputs.Text.TextDto
  El texto
Returns string
El texto invertido
- Defined in bitbybit-docs.d.ts:56891

concat

concat(inputs: TextConcatDto): string
Une varios textos en uno sin nada entre ellos.

Ejemplo: ['hello', ' ', 'world'] -> 'hello world'
Parameters
- inputs: TextConcatDto
  Los textos que unir
Returns string
El texto unido
Example
```
const sentence = bitbybit.text.concat({ texts: ["hello", " ", "world"] });
```
- Defined in bitbybit-docs.d.ts:56928

vector

vectorChar

vectorChar(inputs: VectorCharDto): VectorCharData
Dibuja un carácter como rutas de líneas con una fuente de trazo simple.

Las rutas están tumbadas en el plano XZ, escaladas para que el carácter mida height de alto, y se devuelven con la anchura y la altura del carácter. Un carácter desconocido se dibuja como un signo de interrogación. Ejemplo: 'A' con altura 10 -> los trazos de una A, de 10 unidades de alto
Parameters
- inputs: VectorCharDto
  El carácter, su altura y sus desplazamientos
Returns VectorCharData
La anchura, la altura y las rutas de trazo del carácter como listas de puntos
Example
```
const letter = bitbybit.text.vectorChar({ char: "A", height: 10, xOffset: 0, yOffset: 0, extrudeOffset: 0 });
```
- Defined in bitbybit-docs.d.ts:57026

vectorText

vectorText(inputs: VectorTextDto): VectorTextData[]
Dibuja un texto, con saltos de línea, como rutas de líneas con una fuente de trazo simple.

Cada línea vuelve como sus caracteres con sus rutas, dispuestos en el plano XZ con la altura, el espaciado y la alineación dados; centerOnOrigin pone el centro del bloque en el origen. Ejemplo: 'Hello' con altura 10 -> cinco caracteres con sus trazos
Parameters
- inputs: VectorTextDto
  El texto y cómo disponerlo
Returns VectorTextData[]
Una entrada por línea, cada una con sus caracteres y sus rutas de trazo
Example
```
const lines = bitbybit.text.vectorText({
    text: "Hello\nWorld",
    height: 10,
    align: Bit.Inputs.Base.horizontalAlignEnum.center,
    centerOnOrigin: true,
});
```
- Defined in bitbybit-docs.d.ts:57049

Class TextBitByBit

Index

Constructors

create

query

regex

transform

vector

Constructors

constructor

Parameters

Returns TextBitByBit

create

create

Parameters

Returns string

query

includes

Parameters

Returns boolean

Example

startsWith

Parameters

Returns boolean

Example

endsWith

Parameters

Returns boolean

Example

indexOf

Parameters

Returns number

Example

lastIndexOf

Parameters

Returns number

Example

charAt

Parameters

Returns string

Example

length

Parameters

Returns number

isEmpty

Parameters

Returns boolean

regex

regexTest

Parameters

Returns boolean

Example

regexMatch

Parameters

Returns string[]

Example

regexReplace

Parameters

Returns string

Example

regexSearch

Parameters

Returns number

Example

regexSplit

Parameters

Returns string[]

Example

transform

split

Parameters

Returns string[]

Example

replaceAll

Parameters

Returns string

Example

join

Parameters

Returns string