@synstack/str 1.0.1-alpha.0

package/dist/str.index.d.cts

@@ -0,0 +1,261 @@
+export { camelCase, capitalCase, constantCase, dotCase, kebabCase, noCase, pascalCase, pascalSnakeCase, pathCase, sentenceCase, snakeCase, trainCase } from 'change-case';
+import { Pipeable } from '@synstack/pipe';
+
+type Stringable = {
+    toString: () => string;
+};
+declare class Str extends Pipeable<Str, string> {
+    private readonly text;
+    constructor(text: string);
+    valueOf(): string;
+    toString(): string;
+    instanceOf(): Str;
+    /**
+     * Remove empty lines at the start of the text but leave whitespace on the first line with content
+     */
+    chopEmptyLinesStart(): Str;
+    /**
+     * Remove empty lines at the end of the text but leave whitespace on the last line with content
+     */
+    chopEmptyLinesEnd(): Str;
+    /**
+     * Remove all space (\s) characters in lines without content
+     */
+    trimEmptyLines(): Str;
+    /**
+     * Remove all spaces (\s) characters at the end of lines
+     */
+    trimLinesTrailingSpaces(): Str;
+    /**
+     * Removes the leading and trailing white space and line terminator characters
+     */
+    trim(): Str;
+    /**
+     * Removes the leading white space and line terminator characters
+     */
+    trimStart(): Str;
+    /**
+     * Removes the trailing white space and line terminator characters
+     */
+    trimEnd(): Str;
+    /**
+     * Split a string into substrings using the specified separator and return them as an array
+     */
+    split(separator: string | RegExp, limit?: number): Str[];
+    /**
+     * Add line numbers to a string
+     * @param separator The separator to use between the line number and the line content.
+     * Defaults to ":"
+     */
+    addLineNumbers(separator?: string): Str;
+    /**
+     * Returns the character at the specified index
+     * @return string or undefined if the index is out of bounds
+     */
+    at(index: number): string | undefined;
+    /**
+     * Returns the length of the string
+     */
+    length(): number;
+    /**
+     * Indent the string by the specified number of spaces
+     * @param size The number of spaces to indent by
+     * @param char The character to use for indentation. Defaults to " "
+     */
+    indent(size: number, char?: string): Str;
+    /**
+     * Dedent the string by the specified number of spaces
+     * @param indentation The number of spaces to dedent by.
+     * If not provided, it will be calculated automatically based on the maximum indentation in the string.
+     */
+    dedent(indentation?: number): Str;
+    /**
+     * Chop the string at the start by the specified number of characters
+     */
+    chopStart(count: number): Str;
+    /**
+     * Chop the string at the end by the specified number of characters
+     */
+    chopEnd(count: number): Str;
+    /**
+     * Remove successive newlines of the specified repetition or more
+     * @param maxRepeat the maximum number of newlines to allow
+     */
+    chopRepeatNewlines(maxRepeat: number): Str;
+    /**
+     * Take the first n characters of the string
+     */
+    takeStart(count: number): Str;
+    /**
+     * Take the last n characters of the string
+     */
+    takeEnd(count: number): Str;
+    /**
+     * Returns the last line of the string
+     */
+    lastLine(): Str;
+    /**
+     * Returns the first line of the string
+     */
+    firstLine(): Str;
+    /**
+     * Returns the number of leading spaces in the string
+     */
+    leadingSpacesCount(): number;
+    /**
+     * Returns the indentation level of the string skipping empty lines in the process
+     */
+    indentation(): number;
+    /**
+     * Returns true if the string is empty or contains only whitespace
+     */
+    isEmpty(): boolean;
+    /**
+     * Converts the string to camel case
+     */
+    camelCase(): Str;
+    /**
+     * Converts the string to capital case
+     */
+    capitalCase(): Str;
+    /**
+     * Converts the string to constant case
+     */
+    constantCase(): Str;
+    /**
+     * Converts the string to dot case
+     */
+    dotCase(): Str;
+    /**
+     * Converts the string to kebab case
+     */
+    kebabCase(): Str;
+    /**
+     * Converts the string to no case
+     */
+    noCase(): Str;
+    /**
+     * Converts the string to pascal case
+     */
+    pascalCase(): Str;
+    /**
+     * Converts the string to pascal snake case
+     */
+    pascalSnakeCase(): Str;
+    /**
+     * Converts the string to path case
+     */
+    pathCase(): Str;
+    /**
+     * Converts the string to sentence case
+     */
+    sentenceCase(): Str;
+    /**
+     * Converts the string to snake case
+     */
+    snakeCase(): Str;
+    /**
+     * Converts the string to train case
+     */
+    trainCase(): Str;
+    /**
+     * Shorthand for `.toString()`
+     */
+    get str(): string;
+}
+declare const str: (text: Stringable) => Str;
+
+/**
+ * Remove empty lines at the start of the text but leave whitespace on the first line with content
+ */
+declare const chopEmptyLinesStart: (text: string) => string;
+/**
+ * Remove empty lines at the end of the text but leave whitespace on the last line with content
+ */
+declare const chopEmptyLinesEnd: (text: string) => string;
+/**
+ * Remove all space (\s) characters in lines without content
+ */
+declare const trimEmptyLines: (text: string) => string;
+/**
+ * Remove all space (\s) characters at the end of lines
+ */
+declare const trimLinesTrailingSpaces: (text: string) => string;
+/**
+ * Removes the leading and trailing white space and line terminator characters
+ */
+declare const trim: (text: string) => string;
+/**
+ * Removes the leading white space and line terminator characters
+ */
+declare const trimStart: (text: string) => string;
+/**
+ * Removes the trailing white space and line terminator characters
+ */
+declare const trimEnd: (text: string) => string;
+/**
+ * Split a string into substrings using the specified separator and return them as an array
+ */
+declare const split: (text: string, separator: string | RegExp, limit?: number) => string[];
+/**
+ * Add line numbers to a string
+ * @param text The string to add line numbers to
+ * @param separator The separator to use between the line number and the line content.
+ * Defaults to ":"
+ */
+declare const addLineNumbers: (text: string, separator?: string) => string;
+/**
+ * Returns the indentation level of the string skipping empty lines in the process
+ */
+declare const indentation: (text: string) => number;
+/**
+ * Indent the string by the specified number of spaces
+ * @param size The number of spaces to indent by
+ * @param char The character to use for indentation. Defaults to " "
+ */
+declare const indent: (text: string, size: number, char?: string) => string;
+/**
+ * Dedent the string by the specified number of spaces
+ * @param indentation The number of spaces to dedent by.
+ * If not provided, it will be calculated automatically based on the maximum indentation in the string.
+ */
+declare const dedent: (text: string, size?: number) => string;
+/**
+ * Chop the string at the end by the specified number of characters
+ */
+declare const chopEnd: (text: string, count: number) => string;
+/**
+ * Chop the string at the start by the specified number of characters
+ */
+declare const chopStart: (text: string, count: number) => string;
+/**
+ * Remove successive newlines of the specified repetition or more
+ * @param maxRepeat the maximum number of newlines to allow
+ */
+declare const chopRepeatNewlines: (text: string, maxRepeat: number) => string;
+/**
+ * Take the first n characters of the string
+ */
+declare const takeStart: (text: string, count: number) => string;
+/**
+ * Take the last n characters of the string
+ */
+declare const takeEnd: (text: string, count: number) => string;
+/**
+ * Returns the last line of the string
+ */
+declare const lastLine: (text: string) => string;
+/**
+ * Returns the first line of the string
+ */
+declare const firstLine: (text: string) => string;
+/**
+ * Returns the number of leading spaces in the string
+ */
+declare const leadingSpacesCount: (text: string) => number;
+/**
+ * Returns true if the string is empty or contains only whitespace
+ */
+declare const isEmpty: (text: string) => boolean;
+
+export { Str, addLineNumbers, chopEmptyLinesEnd, chopEmptyLinesStart, chopEnd, chopRepeatNewlines, chopStart, dedent, firstLine, indent, indentation, isEmpty, lastLine, leadingSpacesCount, split, str, takeEnd, takeStart, trim, trimEmptyLines, trimEnd, trimLinesTrailingSpaces, trimStart };

package/dist/str.index.d.ts

@@ -0,0 +1,261 @@
+export { camelCase, capitalCase, constantCase, dotCase, kebabCase, noCase, pascalCase, pascalSnakeCase, pathCase, sentenceCase, snakeCase, trainCase } from 'change-case';
+import { Pipeable } from '@synstack/pipe';
+
+type Stringable = {
+    toString: () => string;
+};
+declare class Str extends Pipeable<Str, string> {
+    private readonly text;
+    constructor(text: string);
+    valueOf(): string;
+    toString(): string;
+    instanceOf(): Str;
+    /**
+     * Remove empty lines at the start of the text but leave whitespace on the first line with content
+     */
+    chopEmptyLinesStart(): Str;
+    /**
+     * Remove empty lines at the end of the text but leave whitespace on the last line with content
+     */
+    chopEmptyLinesEnd(): Str;
+    /**
+     * Remove all space (\s) characters in lines without content
+     */
+    trimEmptyLines(): Str;
+    /**
+     * Remove all spaces (\s) characters at the end of lines
+     */
+    trimLinesTrailingSpaces(): Str;
+    /**
+     * Removes the leading and trailing white space and line terminator characters
+     */
+    trim(): Str;
+    /**
+     * Removes the leading white space and line terminator characters
+     */
+    trimStart(): Str;
+    /**
+     * Removes the trailing white space and line terminator characters
+     */
+    trimEnd(): Str;
+    /**
+     * Split a string into substrings using the specified separator and return them as an array
+     */
+    split(separator: string | RegExp, limit?: number): Str[];
+    /**
+     * Add line numbers to a string
+     * @param separator The separator to use between the line number and the line content.
+     * Defaults to ":"
+     */
+    addLineNumbers(separator?: string): Str;
+    /**
+     * Returns the character at the specified index
+     * @return string or undefined if the index is out of bounds
+     */
+    at(index: number): string | undefined;
+    /**
+     * Returns the length of the string
+     */
+    length(): number;
+    /**
+     * Indent the string by the specified number of spaces
+     * @param size The number of spaces to indent by
+     * @param char The character to use for indentation. Defaults to " "
+     */
+    indent(size: number, char?: string): Str;
+    /**
+     * Dedent the string by the specified number of spaces
+     * @param indentation The number of spaces to dedent by.
+     * If not provided, it will be calculated automatically based on the maximum indentation in the string.
+     */
+    dedent(indentation?: number): Str;
+    /**
+     * Chop the string at the start by the specified number of characters
+     */
+    chopStart(count: number): Str;
+    /**
+     * Chop the string at the end by the specified number of characters
+     */
+    chopEnd(count: number): Str;
+    /**
+     * Remove successive newlines of the specified repetition or more
+     * @param maxRepeat the maximum number of newlines to allow
+     */
+    chopRepeatNewlines(maxRepeat: number): Str;
+    /**
+     * Take the first n characters of the string
+     */
+    takeStart(count: number): Str;
+    /**
+     * Take the last n characters of the string
+     */
+    takeEnd(count: number): Str;
+    /**
+     * Returns the last line of the string
+     */
+    lastLine(): Str;
+    /**
+     * Returns the first line of the string
+     */
+    firstLine(): Str;
+    /**
+     * Returns the number of leading spaces in the string
+     */
+    leadingSpacesCount(): number;
+    /**
+     * Returns the indentation level of the string skipping empty lines in the process
+     */
+    indentation(): number;
+    /**
+     * Returns true if the string is empty or contains only whitespace
+     */
+    isEmpty(): boolean;
+    /**
+     * Converts the string to camel case
+     */
+    camelCase(): Str;
+    /**
+     * Converts the string to capital case
+     */
+    capitalCase(): Str;
+    /**
+     * Converts the string to constant case
+     */
+    constantCase(): Str;
+    /**
+     * Converts the string to dot case
+     */
+    dotCase(): Str;
+    /**
+     * Converts the string to kebab case
+     */
+    kebabCase(): Str;
+    /**
+     * Converts the string to no case
+     */
+    noCase(): Str;
+    /**
+     * Converts the string to pascal case
+     */
+    pascalCase(): Str;
+    /**
+     * Converts the string to pascal snake case
+     */
+    pascalSnakeCase(): Str;
+    /**
+     * Converts the string to path case
+     */
+    pathCase(): Str;
+    /**
+     * Converts the string to sentence case
+     */
+    sentenceCase(): Str;
+    /**
+     * Converts the string to snake case
+     */
+    snakeCase(): Str;
+    /**
+     * Converts the string to train case
+     */
+    trainCase(): Str;
+    /**
+     * Shorthand for `.toString()`
+     */
+    get str(): string;
+}
+declare const str: (text: Stringable) => Str;
+
+/**
+ * Remove empty lines at the start of the text but leave whitespace on the first line with content
+ */
+declare const chopEmptyLinesStart: (text: string) => string;
+/**
+ * Remove empty lines at the end of the text but leave whitespace on the last line with content
+ */
+declare const chopEmptyLinesEnd: (text: string) => string;
+/**
+ * Remove all space (\s) characters in lines without content
+ */
+declare const trimEmptyLines: (text: string) => string;
+/**
+ * Remove all space (\s) characters at the end of lines
+ */
+declare const trimLinesTrailingSpaces: (text: string) => string;
+/**
+ * Removes the leading and trailing white space and line terminator characters
+ */
+declare const trim: (text: string) => string;
+/**
+ * Removes the leading white space and line terminator characters
+ */
+declare const trimStart: (text: string) => string;
+/**
+ * Removes the trailing white space and line terminator characters
+ */
+declare const trimEnd: (text: string) => string;
+/**
+ * Split a string into substrings using the specified separator and return them as an array
+ */
+declare const split: (text: string, separator: string | RegExp, limit?: number) => string[];
+/**
+ * Add line numbers to a string
+ * @param text The string to add line numbers to
+ * @param separator The separator to use between the line number and the line content.
+ * Defaults to ":"
+ */
+declare const addLineNumbers: (text: string, separator?: string) => string;
+/**
+ * Returns the indentation level of the string skipping empty lines in the process
+ */
+declare const indentation: (text: string) => number;
+/**
+ * Indent the string by the specified number of spaces
+ * @param size The number of spaces to indent by
+ * @param char The character to use for indentation. Defaults to " "
+ */
+declare const indent: (text: string, size: number, char?: string) => string;
+/**
+ * Dedent the string by the specified number of spaces
+ * @param indentation The number of spaces to dedent by.
+ * If not provided, it will be calculated automatically based on the maximum indentation in the string.
+ */
+declare const dedent: (text: string, size?: number) => string;
+/**
+ * Chop the string at the end by the specified number of characters
+ */
+declare const chopEnd: (text: string, count: number) => string;
+/**
+ * Chop the string at the start by the specified number of characters
+ */
+declare const chopStart: (text: string, count: number) => string;
+/**
+ * Remove successive newlines of the specified repetition or more
+ * @param maxRepeat the maximum number of newlines to allow
+ */
+declare const chopRepeatNewlines: (text: string, maxRepeat: number) => string;
+/**
+ * Take the first n characters of the string
+ */
+declare const takeStart: (text: string, count: number) => string;
+/**
+ * Take the last n characters of the string
+ */
+declare const takeEnd: (text: string, count: number) => string;
+/**
+ * Returns the last line of the string
+ */
+declare const lastLine: (text: string) => string;
+/**
+ * Returns the first line of the string
+ */
+declare const firstLine: (text: string) => string;
+/**
+ * Returns the number of leading spaces in the string
+ */
+declare const leadingSpacesCount: (text: string) => number;
+/**
+ * Returns true if the string is empty or contains only whitespace
+ */
+declare const isEmpty: (text: string) => boolean;
+
+export { Str, addLineNumbers, chopEmptyLinesEnd, chopEmptyLinesStart, chopEnd, chopRepeatNewlines, chopStart, dedent, firstLine, indent, indentation, isEmpty, lastLine, leadingSpacesCount, split, str, takeEnd, takeStart, trim, trimEmptyLines, trimEnd, trimLinesTrailingSpaces, trimStart };