Skip to main content

API Overview

Functions

ends-with ( $string, $substring [, $end-at] )

Determines whether a string ends with the characters of a specified substring, returning true or false as appropriate.

from ( $value )

Creates a normalized string from the provided value, with unique punctuation differentiating types and characteristics.

includes ( $string, $substring [, $start-at] )

Determines whether a string includes the characters of a specified substring, returning true or false as appropriate.

index ( $string, $substring [, $start-at] )

Returns the first index at which a specified substring can be found in a string; otherwise, 0 is returned, indicating the substring is not present.

is-quoted ( $string )

Determines whether a string is quoted, returning true or false as appropriate.

last-index ( $string, $substring [, $end-at] )

Returns the last index at which a specified substring can be found in a string; otherwise, 0 is returned, indicating the substring is not present. The string is searched forwards, ending at a given index when specified.

replace ( $string, $substring, $replacement )

Replaces all instances of a specified substring from the source string with a given replacement.

split ( $string [, $delimiter] [, $limit] [, $separator] [, $bracketed] )

Divides a string into a list of substrings.

starts-with ( $string, $substring [, $start-at] )

Determines whether a string begins with the characters of a specified substring, returning true or false as appropriate.

trim ( $string )

Removes whitespace from both ends of a string. Whitespace in this context is all the whitespace characters (space, tab, no-break space, etc.) and all the line terminator characters (LF, CR, etc.).

trim-end ( $string )

Removes whitespace from the end of a string.

trim-start ( $string )

Removes whitespace from the beginning of a string.

Don’t see the function you’re looking for? Request a new feature describing a use case.

Combined API

In order to avoid constantly declaring both the native sass:string module and this library, the combined API has been added which merges the two.

// Rather than using both modules separately...
@use '@sass-fairy/string';
@use 'sass:string';

// ...this statement will accomplish the same thing.
@use '@sass-fairy/string/string';
note

Since its functionality is enhanced by this library, the combined API hides the native string.index() function.