list.d.ts 1.23 KB
export type List = {
  /**
   * Safely splits values.
   *
   * ```js
   * Once (root, { list }) {
   *   list.split('1px calc(10% + 1px)', [' ', '\n', '\t']) //=> ['1px', 'calc(10% + 1px)']
   * }
   * ```
   *
   * @param string separated values.
   * @param separators array of separators.
   * @param last boolean indicator.
   * @return Split values.
   */
  split(string: string, separators: string[], last: boolean): string[]
  /**
   * Safely splits space-separated values (such as those for `background`,
   * `border-radius`, and other shorthand properties).
   *
   * ```js
   * Once (root, { list }) {
   *   list.space('1px calc(10% + 1px)') //=> ['1px', 'calc(10% + 1px)']
   * }
   * ```
   *
   * @param str Space-separated values.
   * @return Split values.
   */
  space(str: string): string[]

  /**
   * Safely splits comma-separated values (such as those for `transition-*`
   * and `background` properties).
   *
   * ```js
   * Once (root, { list }) {
   *   list.comma('black, linear-gradient(white, black)')
   *   //=> ['black', 'linear-gradient(white, black)']
   * }
   * ```
   *
   * @param str Comma-separated values.
   * @return Split values.
   */
  comma(str: string): string[]
}

declare const list: List

export default list