XUXI

Usages

ocx

import x from 'xuxi';

x.ocx(
  { a: 1 },
  [{ b: 2 }, { d: 4, e: null }, { f: undefined, g: NaN }],
  () => ({ c: 3 }),
  key => key?.a && { 'key?.a': key.a === 1 },
  {},
  0, // will be ignored
  'string', // will be ignored
  null, // will be ignored
  NaN // will be ignored
);
// { a: 1, b: 2, d: 4, c: 3, 'key?.a': true }

---

object

• .raw()

  A version of ocx that performs deep merging without removing falsy values.

import x from 'xuxi';

const result = x.object.raw({ enabled: false, features: { darkMode: true } }, { features: { darkMode: null, betaMode: true } });

console.log(result);
// { enabled: false, features: { darkMode: null, betaMode: true } }

• .preserve()

  A version of ocx that performs a deep join without overwriting the value at the first key, only change the value if it does not exist and without removing falsy values.

import x from 'xuxi';

const obj1 = { key1: { nestedKey1: { subKey: 'value1', subKey3: false } } };
const objFn = () => ({ key1: { nestedKey1: { subKey: 'newValue1', subKey2: 'value2', subKey3: 'value3' } } });

const result = x.object.preserve(obj1, objFn);
console.log(result);
// {
//   key1: {
//     nestedKey1: { subKey: 'value1', subKey3: false, subKey2: 'value2' }
//   }
// }

---

cvx

import x from 'xuxi';

const classes = x.cvx({
  // assign values that is definitely returned
  assign: 'bg-muted rounded-sm px-2 border flex items-center justify-center',
  variants: {
    variant: {
      light: 'font-light',
      bold: 'font-bold',
      semibold: 'font-semibold'
    },
    effect: {
      italic: 'font-italic'
    },
    color: {
      blue: 'text-blue-600',
      green: 'text-green-700',
      red: 'text-red-500',
      purple: 'text-purple-500'
    },
    size: {
      sm: 'h-4',
      md: 'h-6',
      lg: 'h-10',
      xl: 'h-14'
    }
  },
  // determine the variance value by default
  defaultVariants: {
    variant: 'bold',
    color: 'blue',
    size: 'lg'
  }
});

Cvx Types

const xx = cvx({
  assign: 'CLASS',
  variants: { state: { Infinity: 'IS_INFINITY', NaN: 'IS_NAN', true: 'IS_TRUE', false: 'IS_FALSE', null: 'IS_NULL', undefined: 'IS_UNDEFINED' } }
});

console.log(xx({ state: true })); // ✅ (valid)
console.log(xx({ state: false })); // ✅ (valid)
console.log(xx({ state: Infinity })); // ✅ (valid)
console.log(xx({ state: null })); // ✅ (valid)
console.log(xx({ state: NaN })); // ✅ (valid)
console.log(xx({ state: undefined })); // ✅ (valid)
console.log(xx({ state: 'random' as any })); // ❌ (not found!)

type state = cvxVariants<typeof xx>['state'];
// type state = number | boolean | null | undefined

---

cnx

import x from 'xuxi';

// allows receiving Arrays, Objects and Functions
x.cnx(['', baz, (foo as string) !== 'foo' && bar], { '': !props }, '', () => ({ '' }), undefined, [{ '' }, () => ({ '' })]);

string

// examples input
const response = {
  status: 'success',
  data: { user: 'JohnDoe', admin: true },
  [Symbol('meta')]: 'confidential'
};
const input = [
  'btn',
  null,
  false,
  undefined,
  { 'btn-primary': true, 'btn-disabled': false },
  ['shadow', 'rounded'],
  response,
  new Date('2025-02-05'),
  new Map([
    ['key1', 'value1'],
    ['key2', 'value2']
  ]),
  new Set(['unique1', 'unique2'])
];

• .toString()

  Recursively serializes objects, arrays, and nested structures into a flattened key=value pair string.

import x from 'xuxi';

console.log(x.string(input).toString());
// "btn btn-primary shadow rounded status data"

• .recursive()

  Recursively serializes objects, arrays, and nested structures into a flattened key=value pair string.

import x from 'xuxi';

console.log(x.string(input).recursive());
// "btn-primary: true status: success data.user: JohnDoe data.admin: true Symbol(meta): confidential"
console.log(x.string(input).recursive({ separator: ', ' }));
// "btn-primary: true, status: success, data.user: JohnDoe, data.admin: true, Symbol(meta): confidential"

• .instanceof()

  Detects specific object types like Date, Map, and Set, and converts them into human-readable strings.

import x from 'xuxi';

console.log(x.string(input).instanceof());
// "2025-02-05T00:00:00.000Z key1: value1 key2: value2 unique1 unique2"
console.log(x.string(input).instanceof({ separator: ', ' }));
// "2025-02-05T00:00:00.000Z, key1: value1, key2: value2, unique1, unique2"

---

clean

import x from 'xuxi';

const cleanedObject = {
  name: 'Bob',
  age: null,
  active: false,
  score: 0,
  address: ''
};

console.log(x.clean(cleanedObject));
// { name: "Bob" }

console.log(x.clean(cleanedObject, [0]));
// { name: "Bob", score: 0 }

---

Documentation

Repository

Installation

Bundles

Score and Test