11/**
2- * Converts an array of strings to a comma-separated sentence
3- * @param items {Array<string>}
4- * @returns {string } Returns a string with the items joined by a comma and the last item joined by ", or"
2+ * Convert words to a sentence.
3+ *
4+ * @param items - An array of words to be joined.
5+ * @returns A string with the items joined by a comma and the last item joined by ", or".
56 */
67export const toSentence = ( items : string [ ] ) : string => {
78 // TODO: Once Safari supports it, use Intl.ListFormat
@@ -19,19 +20,41 @@ export const toSentence = (items: string[]): string => {
1920const IP_V4_ADDRESS_REGEX =
2021 / ^ ( 2 5 [ 0 - 5 ] | 2 [ 0 - 4 ] [ 0 - 9 ] | [ 0 1 ] ? [ 0 - 9 ] [ 0 - 9 ] ? ) \. ( 2 5 [ 0 - 5 ] | 2 [ 0 - 4 ] [ 0 - 9 ] | [ 0 1 ] ? [ 0 - 9 ] [ 0 - 9 ] ? ) \. ( 2 5 [ 0 - 5 ] | 2 [ 0 - 4 ] [ 0 - 9 ] | [ 0 1 ] ? [ 0 - 9 ] [ 0 - 9 ] ? ) \. ( 2 5 [ 0 - 5 ] | 2 [ 0 - 4 ] [ 0 - 9 ] | [ 0 1 ] ? [ 0 - 9 ] [ 0 - 9 ] ? ) $ / ;
2122
23+ /**
24+ * Checks if a string is a valid IPv4 address.
25+ *
26+ * @returns True if the string is a valid IPv4 address, false otherwise.
27+ */
2228export function isIPV4Address ( str : string | undefined | null ) : boolean {
2329 return IP_V4_ADDRESS_REGEX . test ( str || '' ) ;
2430}
2531
32+ /**
33+ * Converts the first character of a string to uppercase.
34+ *
35+ * @param str - The string to be converted.
36+ * @returns The modified string with the rest of the string unchanged.
37+ *
38+ * @example
39+ * ```ts
40+ * titleize('hello world') // 'Hello world'
41+ * ```
42+ */
2643export function titleize ( str : string | undefined | null ) : string {
2744 const s = str || '' ;
2845 return s . charAt ( 0 ) . toUpperCase ( ) + s . slice ( 1 ) ;
2946}
3047
48+ /**
49+ * Converts a string from snake_case to camelCase.
50+ */
3151export function snakeToCamel ( str : string | undefined ) : string {
3252 return str ? str . replace ( / ( [ - _ ] [ a - z ] ) / g, match => match . toUpperCase ( ) . replace ( / - | _ / , '' ) ) : '' ;
3353}
3454
55+ /**
56+ * Converts a string from camelCase to snake_case.
57+ */
3558export function camelToSnake ( str : string | undefined ) : string {
3659 return str ? str . replace ( / [ A - Z ] / g, letter => `_${ letter . toLowerCase ( ) } ) : '' ;
3760}
@@ -73,6 +96,7 @@ const createDeepObjectTransformer = (transform: any) => {
7396 * Transforms camelCased objects/ arrays to snake_cased.
7497 * This function recursively traverses all objects and arrays of the passed value
7598 * camelCased keys are removed.
99+ *
76100 * @function
77101 */
78102export const deepCamelToSnake = createDeepObjectTransformer ( camelToSnake ) ;
@@ -81,13 +105,15 @@ export const deepCamelToSnake = createDeepObjectTransformer(camelToSnake);
81105 * Transforms snake_cased objects/ arrays to camelCased.
82106 * This function recursively traverses all objects and arrays of the passed value
83107 * camelCased keys are removed.
108+ *
84109 * @function
85110 */
86111export const deepSnakeToCamel = createDeepObjectTransformer ( snakeToCamel ) ;
87112
88113/**
89- * Returns true for `true`, true, positive numbers.
90- * Returns false for `false`, false, 0, negative integers and anything else.
114+ * A function to determine if a value is truthy.
115+ *
116+ * @returns True for `true`, true, positive numbers. False for `false`, false, 0, negative integers and anything else.
91117 */
92118export function isTruthy ( value : unknown ) : boolean {
93119 // Return if Boolean
@@ -125,6 +151,9 @@ export function isTruthy(value: unknown): boolean {
125151 return false ;
126152}
127153
154+ /**
155+ * Get all non-undefined values from an object.
156+ */
128157export function getNonUndefinedValues < T extends object > ( obj : T ) : Partial < T > {
129158 return Object . entries ( obj ) . reduce ( ( acc , [ key , value ] ) => {
130159 if ( value !== undefined ) {
0 commit comments