@douglasneuroinformatics/libjs 0.6.0 → 0.7.0

package/dist/string.d.ts

@@ -1,8 +1,9 @@
-import type { CamelCase, SnakeCase } from 'type-fest';
+import type { CamelCase, Primitive, SnakeCase } from 'type-fest';
 export declare function camelToSnakeCase<T extends string>(s: T): SnakeCase<T>;
 export declare function snakeToCamelCase<T extends string>(s: T): CamelCase<T>;
 export declare function uncapitalize<T extends string>(s: T): Uncapitalize<T>;
 export declare function capitalize<T extends string>(s: T): Capitalize<T>;
 export declare function toLowerCase<T extends string>(s: T): Lowercase<T>;
 export declare function toUpperCase<T extends string>(s: T): Uppercase<T>;
+export declare function format(s: string, ...args: Exclude<Primitive, symbol>[]): string;
 //# sourceMappingURL=string.d.ts.map

package/dist/string.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../src/string.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEtD,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,gBAEtD;AAED,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,gBAItD;AAED,wBAAgB,YAAY,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,mBAElD;AAED,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,iBAEhD;AAED,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,gBAEjD;AAED,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,gBAEjD"}
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../src/string.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEjE,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,gBAEtD;AAED,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,gBAItD;AAED,wBAAgB,YAAY,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,mBAElD;AAED,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,iBAEhD;AAED,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,gBAEjD;AAED,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,gBAEjD;AAED,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,UAKtE"}

package/dist/string.js

@@ -18,3 +18,10 @@ export function toLowerCase(s) {
 export function toUpperCase(s) {
     return s.toUpperCase();
 }
+export function format(s, ...args) {
+    for (const arg of args) {
+        s = s.replace('{}', String(arg));
+    }
+    return s;
+}
+console.log(format('Hello {}', 'World'));

package/dist/string.test.js

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest';
-import { camelToSnakeCase, capitalize, snakeToCamelCase, toLowerCase, toUpperCase, uncapitalize } from './string.js';
+import { camelToSnakeCase, capitalize, format, snakeToCamelCase, toLowerCase, toUpperCase, uncapitalize } from './string.js';
 describe('camelToSnakeCase', () => {
     it('should convert from camel to snake case ', () => {
         expect(camelToSnakeCase('toSnakeCase')).toBe('to_snake_case');
@@ -38,3 +38,16 @@ describe('toUpperCase', () => {
         expect(toUpperCase('foo')).toBe('FOO');
     });
 });
+describe('format', () => {
+    it('should return the same string if no positional args are given', () => {
+        expect(format('Hello')).toBe('Hello');
+        expect(format('Hello {}')).toBe('Hello {}');
+    });
+    it('should insert positional arguments', () => {
+        expect(format('Hello {}', 'World')).toBe('Hello World');
+        expect(format('Hello {}. {}.', 'World', 'This function works')).toBe('Hello World. This function works.');
+    });
+    it('should ignore additional indices', () => {
+        expect(format('Hello {}{}.', 'World')).toBe('Hello World{}.');
+    });
+});

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@douglasneuroinformatics/libjs",
   "type": "module",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "packageManager": "pnpm@9.3.0",
   "description": "A collection of utility functions and types for Node.js and the browser",
   "author": "Joshua Unrau",