@stacksjs/strings 0.58.73 → 0.59.1

package/dist/case.d.ts

@@ -0,0 +1,11 @@
+/**
+ * First letter uppercase, other lowercase
+ * @category string
+ * @example
+ * ```
+ * capitalize('hello world') => 'Hello world'
+ * ```
+ */
+export declare function capitalize(str: string): string;
+export { camelCase, capitalCase, constantCase, dotCase, noCase, kebabCase, kebabCase as paramCase, pascalCase, pathCase, sentenceCase, snakeCase, split, } from 'change-case';
+export { titleCase } from 'title-case';

package/dist/helpers.d.ts

@@ -0,0 +1 @@
+export declare function toString(v: any): string;

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './string';
+export * as string from './string';

package/dist/macro.d.ts

@@ -0,0 +1,70 @@
+export declare const Str: {
+    slash(str: string): string;
+    ensurePrefix(prefix: string, str: string): string;
+    ensureSuffix(suffix: string, str: string): string;
+    template(str: string, ...args: any[]): string;
+    /**
+     * Truncate a string
+     */
+    truncate(str: string, length: number, end?: string): string;
+    random(length?: number): string;
+    capitalize(str: string): string;
+    slug(str: string): string;
+    detectIndent(str: string): import("detect-indent").Indent;
+    detectNewline(str: string): "\r\n" | "\n" | undefined;
+    camelCase(str: string): string;
+    capitalCase(str: string): string;
+    constantCase(str: string): string;
+    dotCase(str: string): string;
+    noCase(str: string): string;
+    paramCase(str: string): string;
+    pascalCase(str: string): string;
+    pathCase(str: string): string;
+    sentenceCase(str: string): string;
+    snakeCase(str: string): string;
+    titleCase(str: string): string;
+    kebabCase(str: string): string;
+    plural(str: string): string;
+    singular(str: string): string;
+    isPlural(str: string): boolean;
+    isSingular(str: string): boolean;
+    addPluralRule(rule: string | RegExp, repl: string): void;
+    addSingularRule(rule: string | RegExp, repl: string): void;
+    addIrregularRule(single: string, plural: string): void;
+    addUncountableRule(word: string | RegExp): void;
+};
+export declare const str: {
+    slash(str: string): string;
+    ensurePrefix(prefix: string, str: string): string;
+    ensureSuffix(suffix: string, str: string): string;
+    template(str: string, ...args: any[]): string;
+    /**
+     * Truncate a string
+     */
+    truncate(str: string, length: number, end?: string): string;
+    random(length?: number): string;
+    capitalize(str: string): string;
+    slug(str: string): string;
+    detectIndent(str: string): import("detect-indent").Indent;
+    detectNewline(str: string): "\r\n" | "\n" | undefined;
+    camelCase(str: string): string;
+    capitalCase(str: string): string;
+    constantCase(str: string): string;
+    dotCase(str: string): string;
+    noCase(str: string): string;
+    paramCase(str: string): string;
+    pascalCase(str: string): string;
+    pathCase(str: string): string;
+    sentenceCase(str: string): string;
+    snakeCase(str: string): string;
+    titleCase(str: string): string;
+    kebabCase(str: string): string;
+    plural(str: string): string;
+    singular(str: string): string;
+    isPlural(str: string): boolean;
+    isSingular(str: string): boolean;
+    addPluralRule(rule: string | RegExp, repl: string): void;
+    addSingularRule(rule: string | RegExp, repl: string): void;
+    addIrregularRule(single: string, plural: string): void;
+    addUncountableRule(word: string | RegExp): void;
+};

package/dist/pluralize.d.ts

@@ -0,0 +1,23 @@
+type Rule = string | RegExp;
+type Replacement = string;
+type Word = string;
+export type PluralizeTest = (word: Word) => boolean;
+export interface Pluralize {
+    plural: (word: Word, count?: number, inclusive?: boolean) => Word;
+    singular: (word: Word) => Word;
+    isPlural: (word: Word) => boolean;
+    isSingular: (word: Word) => boolean;
+    addPluralRule: (rule: Rule, replacement: Replacement) => void;
+    addSingularRule: (rule: Rule, replacement: Replacement) => void;
+    addIrregularRule: (single: Word, plural: Word) => void;
+    addUncountableRule: (word: Word | RegExp) => void;
+}
+export declare const plural: Pluralize['plural'];
+export declare const singular: Pluralize['singular'];
+export declare const isPlural: Pluralize['isPlural'];
+export declare const isSingular: Pluralize['isSingular'];
+export declare const addPluralRule: Pluralize['addPluralRule'];
+export declare const addSingularRule: Pluralize['addSingularRule'];
+export declare const addIrregularRule: Pluralize['addIrregularRule'];
+export declare const addUncountableRule: Pluralize['addUncountableRule'];
+export {};

package/dist/string.d.ts

@@ -0,0 +1,5 @@
+export * from './utils';
+export * from './case';
+export * from './pluralize';
+export * from './macro';
+export * from './helpers';

package/dist/utils.d.ts

@@ -0,0 +1,69 @@
+interface SlugOptions {
+    replacement?: string;
+    remove?: RegExp;
+    lower?: boolean;
+    strict?: boolean;
+    locale?: string;
+    trim?: boolean;
+}
+/**
+ * Replace backslash to slash
+ *
+ * @category String
+ * @example
+ * ```
+ * slash('C:\\Users\\Chris') => 'C:/Users/Chris'
+ * ```
+ */
+export declare function slash(str: string): string;
+/**
+ * Ensure prefix of a string
+ *
+ * @category String
+ * @example
+ * ```
+ * ensurePrefix('https://', 'google.com') => 'https://google.com'
+ * ensurePrefix('https://', 'http://google.com') => 'https://google.com'
+ */
+export declare function ensurePrefix(prefix: string, str: string): string;
+/**
+ * Ensure suffix of a string
+ *
+ * @category String
+ * @example
+ * ```
+ * ensureSuffix('.js', 'index') => 'index.js'
+ * ensureSuffix('.js', 'index.js') => 'index.js'
+ * ```
+ */
+export declare function ensureSuffix(suffix: string, str: string): string;
+/**
+ * Dead simple template engine, just like Python's `.format()`
+ *
+ * @category String
+ * @example
+ * ```
+ * const result = template('Hello {0}! My name is {1}.',
+ *   'Buddy',
+ *   'Chris'
+ * ) // Hello Buddy! My name is Chris.
+ * ```
+ */
+export declare function template(str: string, ...args: any[]): string;
+export declare function truncate(str: string, length: number, end?: string): string;
+/**
+ * Generate a random string
+ * @category String
+ */
+export declare function random(size?: number, dict?: string): string;
+/**
+ * Slugify a string
+ * @category string
+ * @example
+ * ```
+ * slug('Hello World') => 'hello-world'
+ * ```
+ */
+export declare function slug(str: string, options?: SlugOptions): string;
+export { default as detectIndent } from 'detect-indent';
+export { detectNewline } from 'detect-newline';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/strings",
   "type": "module",
-  "version": "0.58.73",
+  "version": "0.59.1",
   "description": "The Stacks string utilities.",
   "author": "Chris Breuer",
   "license": "MIT",