The stringTransform API is your tool for all string manipulation tasks. It enables you to transform strings in various ways, from simple case conversions to complex data extractions and sanitizations, all through a fluent and chainable interface.

Getting Started

To use the stringTransform API, import the stringTransform function from the regist library. Pass your string to this function, and then chain any of the available transformation methods.

import { stringTransform } from 'regist';
 
// Example: Convert a string to snake_case
const snakeCase = stringTransform('someStringToConvert').toSnakeCase().try(); 
// Result: 'some_string_to_convert'
 
// Example: Sanitize a string by removing spaces and special characters
const sanitized = stringTransform('  Hello World!  ').sanitize({ removeSpaces: true, removeSpecial: true }).try(); 
// Result: 'HelloWorld'

Chaining Transformations

Like the assertThat API, the stringTransform API is fully chainable. This allows you to apply multiple transformations in a single, elegant statement, making your code both concise and readable.

import { stringTransform } from 'regist';
 
const transformed = stringTransform('  some string  ')
  .trim()
  .toUpperCase()
  .toSnakeCase()
  .try(); // Result: 'SOME_STRING'

API Reference

Here is a comprehensive list of the transformation methods available in the stringTransform API.