Function peel

peel<T extends string = string>(
str: string,
candidates: T[],
): [T | null, string]
Peels a candidate string from the start of a string and splits it into two segments.
Type Parameters
- T extends string = string
Parameters
- str: string
  The string to peel from.
- candidates: T[]
  The candidate list of values to peel from str.
Returns [T | null, string]
A tuple where the first item is the peeled string and the second item is the remainder of the string. If the string does not start with any given candidates, then the first item will be null and the second item will be str.
- Defined in packages/helpful-fn/src/peel/peel.mts:15