Str

const Str: object

Defined in: Data/Str.ts:43

Type Declaration

capitalize

capitalize: (s) => string

Converts the first character of a string to uppercase.

Parameters

s

string

Returns

string

Example

pipe("hello", Str.capitalize); // "Hello"

endsWith

endsWith: (suffix) => (s) => boolean

Returns true when the string ends with the given suffix.

Parameters

suffix

string

Returns

(s) => boolean

Example

pipe("hello world", Str.endsWith("world")); // true
pipe("hello world", Str.endsWith("hello")); // false

includes

includes: (substring) => (s) => boolean

Returns true when the string contains the given substring.

Parameters

substring

string

Returns

(s) => boolean

Example

pipe("hello world", Str.includes("world")); // true
pipe("hello world", Str.includes("xyz"));   // false

is

is: object

is.empty

empty: (s) => boolean = isEmpty

Returns true when the string is empty.

Parameters

s

string

Returns

boolean

Example

pipe("", Str.is.empty);   // true
pipe("hi", Str.is.empty); // false

is.nonEmpty

nonEmpty: (s) => s is NonEmptyString = isNonEmpty

Type guard to check if a string is non-empty.

Parameters

s

string

Returns

s is NonEmptyString

isBlank

isBlank: (s) => boolean

Returns true when the string is empty or contains only whitespace.

Parameters

s

string

Returns

boolean

Example

pipe("   ", Str.isBlank); // true
pipe("hi", Str.isBlank);  // false

length

length: (s) => number

Returns the length of the string.

Parameters

s

string

Returns

number

Example

pipe("hello", Str.length); // 5
pipe("", Str.length);      // 0

lines

lines: (s) => readonly string[]

Splits a string into lines, normalising \r\n and \r line endings.

Parameters

s

string

Returns

readonly string[]

Example

Str.lines("one\ntwo\nthree"); // ["one", "two", "three"]
Str.lines("a\r\nb");         // ["a", "b"]

NonEmpty

NonEmpty: object = StrNonEmptyConst

NonEmpty.from

from: object

NonEmpty.from.String

String: (s) => Maybe<NonEmptyString>

Returns Some containing NonEmptyString if the string is not empty, None otherwise.

Parameters

s

string

Returns

Maybe<NonEmptyString>

Example

Str.NonEmpty.from.String("hello"); // Some("hello")
Str.NonEmpty.from.String("");      // None

padEnd

padEnd: (maxLength, fillString?) => (s) => string

Pads the end of a string to a specified length. Data-last: use in pipe.

Parameters

maxLength

number

fillString?

string

Returns

(s) => string

Example

pipe("hi", Str.padEnd(5, "."));  // "hi..."
pipe("hi", Str.padEnd(5));       // "hi   "

padStart

padStart: (maxLength, fillString?) => (s) => string

Pads the start of a string to a specified length. Data-last: use in pipe.

Parameters

maxLength

number

fillString?

string

Returns

(s) => string

Example

pipe("5", Str.padStart(3, "0")); // "005"
pipe("hi", Str.padStart(5));     // "   hi"

parse

parse: object

Safe number parsers that return Maybe instead of NaN.

parse.float

float: (s) => Maybe<number>

Parses a string as a floating-point number. Returns None if the result is NaN.

Parameters

s

string

Returns

Maybe<number>

Example

Str.parse.float("3.14"); // Some(3.14)
Str.parse.float("42");   // Some(42)
Str.parse.float("abc");  // None

parse.int

int: (s) => Maybe<number>

Parses a string as an integer (base 10). Returns None if the result is NaN.

Parameters

s

string

Returns

Maybe<number>

Example

Str.parse.int("42");   // Some(42)
Str.parse.int("3.7");  // Some(3)
Str.parse.int("abc");  // None

parseJson

parseJson: (s) => Result<SyntaxError, unknown>

Safely parses a JSON string, returning a Result<SyntaxError, unknown>.

Parameters

s

string

Returns

Result<SyntaxError, unknown>

Example

Str.parseJson('{"a": 1}'); // Ok({ a: 1 })
Str.parseJson('invalid');  // Err(SyntaxError)

replace

replace: (pattern, replacement) => (s) => string

Replaces the first occurrence of a pattern in a string. Data-last: use in pipe.

Parameters

pattern

string | RegExp

replacement

string

Returns

(s) => string

Example

pipe("foo foo foo", Str.replace("foo", "bar")); // "bar foo foo"
pipe("Hello World", Str.replace(/world/i, "Earth")); // "Hello Earth"

replaceAll

replaceAll: (pattern, replacement) => (s) => string

Replaces all occurrences of a pattern in a string. Data-last: use in pipe.

Parameters

pattern

string | RegExp

replacement

string

Returns

(s) => string

Example

pipe("foo foo foo", Str.replaceAll("foo", "bar")); // "bar bar bar"
pipe("aAbBaA", Str.replaceAll(/a/gi, "x")); // "xxBBxx"

slice

slice: (start, end?) => (s) => string

Extracts a substring between two indices. Data-last: use in pipe.

Parameters

start

number

end?

number

Returns

(s) => string

Example

pipe("hello", Str.slice(1, 3)); // "el"
pipe("hello", Str.slice(2));    // "llo"

split

split: (separator) => (s) => readonly string[]

Splits a string by a separator. Data-last: use in pipe.

Parameters

separator

string | RegExp

Returns

(s) => readonly string[]

Example

pipe("a,b,c", Str.split(",")); // ["a", "b", "c"]

startsWith

startsWith: (prefix) => (s) => boolean

Returns true when the string starts with the given prefix.

Parameters

prefix

string

Returns

(s) => boolean

Example

pipe("hello world", Str.startsWith("hello")); // true
pipe("hello world", Str.startsWith("world")); // false

toLowerCase

toLowerCase: (s) => string

Converts a string to lowercase.

Parameters

s

string

Returns

string

Example

pipe("HELLO", Str.toLowerCase); // "hello"

toUpperCase

toUpperCase: (s) => string

Converts a string to uppercase.

Parameters

s

string

Returns

string

Example

pipe("hello", Str.toUpperCase); // "HELLO"

trim

trim: (s) => string

Removes leading and trailing whitespace from a string.

Parameters

s

string

Returns

string

Example

pipe("  hello  ", Str.trim); // "hello"

truncate

truncate: (options) => (s) => string

Truncates a string to a maximum length, appending an optional suffix (default "..."). Data-last curried signature.

Parameters

options

length

number

suffix?

string

Returns

(s) => string

Example

pipe("Hello, world!", Str.truncate({ length: 8 })); // "Hello..."
pipe("Hello", Str.truncate({ length: 10 }));        // "Hello"
pipe("Hello, world!", Str.truncate({ length: 8, suffix: "…" })); // "Hello, w…"

uncapitalize

uncapitalize: (s) => string

Converts the first character of a string to lower case.

Parameters

s

string

Returns

string

Example

Str.uncapitalize("Hello"); // "hello"
Str.uncapitalize("");      // ""

words

words: (s) => readonly string[]

Splits a string into words on any whitespace boundary, filtering out empty strings.

Parameters

s

string

Returns

readonly string[]

Example

Str.words("  hello   world  "); // ["hello", "world"]