@oscarpalmer/atoms 0.218.0 → 0.219.0

package/dist/string/index.mjs

@@ -57,7 +57,7 @@ function getUuid(html) {
 *
 * @param value JSON string to parse
 * @param reviver Reviver function to transform the parsed values
-* @returns Parsed value or `undefined` if parsing fails
+* @returns Parsed value, or `undefined` if parsing fails
 */
 function parse(value, reviver) {
 	try {
@@ -71,6 +71,13 @@ function parse(value, reviver) {
 *
 * @param value String to trim
 * @returns Trimmed string
+* @example
+* ```typescript
+* trim('  this is a test  '); // => 'this is a test'
+* trim('this is a test');     // => 'this is a test'
+* trim('   ');                // => ''
+* trim('');                   // => ''
+* ```
 */
 function trim(value) {
 	return typeof value === "string" ? value.trim() : "";
@@ -82,6 +89,13 @@ function trim(value) {
 * @param length Maximum length of the string after truncation
 * @param suffix Suffix to append to the truncated string
 * @returns Truncated string
+* @example
+* ```typescript
+* truncate('this is a test', 7);          // => 'this is'
+* truncate('this is a test', 7, '...');   // => 'this ...'
+* truncate('this is a test', 20);         // => 'this is a test'
+* truncate('this is a test', 0);          // => ''
+* ```
 */
 function truncate(value, length, suffix) {
 	if (typeof value !== "string" || typeof length !== "number" || length === 0) return "";

package/dist/string/match.d.mts

@@ -6,6 +6,14 @@
  * @param needle String to look for
  * @param ignoreCase Ignore case when matching? _(defaults to `false`)_
  * @returns `true` if the string ends with the given substring, otherwise `false`
+ *
+ * @example
+ * ```typescript
+ * endsWith('this is a test', 'test');          // => true
+ * endsWith('this is a test', 'Test');          // => false
+ * endsWith('this is a test', 'Test', true);    // => true
+ * endsWith('this is a test', 'not');           // => false
+ * ```
  */
 export declare function endsWith(haystack: string, needle: string, ignoreCase?: boolean): boolean;
 /**
@@ -15,6 +23,14 @@ export declare function endsWith(haystack: string, needle: string, ignoreCase?:
  * @param needle String to look for
  * @param ignoreCase Ignore case when matching? _(defaults to `false`)_
  * @returns `true` if the string includes the given substring, otherwise `false`
+ *
+ * @example
+ * ```typescript
+ * includes('this is a test', 'is');          // => true
+ * includes('this is a test', 'Is');          // => false
+ * includes('this is a test', 'Is', true);    // => true
+ * includes('this is a test', 'not');         // => false
+ * ```
  */
 export declare function includes(haystack: string, needle: string, ignoreCase?: boolean): boolean;
 /**
@@ -24,6 +40,14 @@ export declare function includes(haystack: string, needle: string, ignoreCase?:
  * @param needle String to look for
  * @param ignoreCase Ignore case when matching? _(defaults to `false`)_
  * @returns `true` if the string starts with the given substring, otherwise `false`
+ *
+ * @example
+ * ```typescript
+ * startsWith('this is a test', 'this');          // => true
+ * startsWith('this is a test', 'This');          // => false
+ * startsWith('this is a test', 'This', true);    // => true
+ * startsWith('this is a test', 'not');           // => false
+ * ```
  */
 export declare function startsWith(haystack: string, needle: string, ignoreCase?: boolean): boolean;
 //#endregion

package/dist/string/match.mjs

@@ -8,6 +8,14 @@ import { memoize } from "../internal/function/memoize.mjs";
 * @param needle String to look for
 * @param ignoreCase Ignore case when matching? _(defaults to `false`)_
 * @returns `true` if the string ends with the given substring, otherwise `false`
+*
+* @example
+* ```typescript
+* endsWith('this is a test', 'test');          // => true
+* endsWith('this is a test', 'Test');          // => false
+* endsWith('this is a test', 'Test', true);    // => true
+* endsWith('this is a test', 'not');           // => false
+* ```
 */
 function endsWith(haystack, needle, ignoreCase) {
 	return match(STRING_MATCH_ENDS_WITH, haystack, needle, ignoreCase === true);
@@ -19,6 +27,14 @@ function endsWith(haystack, needle, ignoreCase) {
 * @param needle String to look for
 * @param ignoreCase Ignore case when matching? _(defaults to `false`)_
 * @returns `true` if the string includes the given substring, otherwise `false`
+*
+* @example
+* ```typescript
+* includes('this is a test', 'is');          // => true
+* includes('this is a test', 'Is');          // => false
+* includes('this is a test', 'Is', true);    // => true
+* includes('this is a test', 'not');         // => false
+* ```
 */
 function includes(haystack, needle, ignoreCase) {
 	return match(STRING_MATCH_INCLUDES, haystack, needle, ignoreCase === true);
@@ -38,6 +54,14 @@ function matchCallback(haystack, needle, ignoreCase) {
 * @param needle String to look for
 * @param ignoreCase Ignore case when matching? _(defaults to `false`)_
 * @returns `true` if the string starts with the given substring, otherwise `false`
+*
+* @example
+* ```typescript
+* startsWith('this is a test', 'this');          // => true
+* startsWith('this is a test', 'This');          // => false
+* startsWith('this is a test', 'This', true);    // => true
+* startsWith('this is a test', 'not');           // => false
+* ```
 */
 function startsWith(haystack, needle, ignoreCase) {
 	return match(STRING_MATCH_STARTS_WITH, haystack, needle, ignoreCase === true);

package/dist/string/template.d.mts

@@ -24,6 +24,10 @@ export declare function template(strings: TemplateStringsArray, ...values: unkno
  * @param variables Variables to use
  * @param options Templating options
  * @returns Templated string
+ * @example
+ * ```typescript
+ * template('Hello, {{name}}!', {name: 'World'}); // => 'Hello, World!'
+ * ```
  */
 export declare function template(value: string, variables?: PlainObject, options?: Partial<TemplateOptions>): string;
 export declare namespace template {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@oscarpalmer/atoms",
-	"version": "0.218.0",
+	"version": "0.219.0",
 	"description": "Atomic utilities for making your JavaScript better.",
 	"keywords": [
 		"array",