12 KiB
@sbrow/strings / Exports
@sbrow/strings
Table of contents
Functions
- afterFirst
- afterFirstWord
- afterLast
- beforeFirst
- beforeFirstWord
- endsWith
- ltrim
- removeFirstWord
- removeWordsFromBeginning
- rtrim
- shorten
- shorterThan
- startsWith
- trim
Functions
afterFirst
▸ afterFirst<P, G, R>(...p): RequiredKeys<ObjectOf<G>> extends never ? R : Curry<(...p: G) => R>
Curry a Function
Example
import {F} from 'ts-toolbelt'
/// If you are looking for creating types for `curry`
/// It handles placeholders and variable arguments
declare function curry<Fn extends F.Function>(fn: Fn): F.Curry<Fn>
Type parameters
| Name | Type |
|---|---|
P |
extends [separator: string | typeof _, str: string | typeof _] |
G |
extends readonly any[] = GapsOf<P, [separator: string, str: string]> |
R |
extends unknown = string |
Parameters
| Name | Type |
|---|---|
...p |
P | [separator: string | typeof _, str: string | typeof _] |
Returns
RequiredKeys<ObjectOf<G>> extends never ? R : Curry<(...p: G) => R>
Defined in
node_modules/ts-toolbelt/out/Function/Curry.d.ts:77
afterFirstWord
▸ afterFirstWord(str): string
Parameters
| Name | Type |
|---|---|
str |
string |
Returns
string
Defined in
afterLast
▸ afterLast<P, G, R>(...p): RequiredKeys<ObjectOf<G>> extends never ? R : Curry<(...p: G) => R>
Curry a Function
Example
import {F} from 'ts-toolbelt'
/// If you are looking for creating types for `curry`
/// It handles placeholders and variable arguments
declare function curry<Fn extends F.Function>(fn: Fn): F.Curry<Fn>
Type parameters
| Name | Type |
|---|---|
P |
extends [separator: string | typeof _, str: string | typeof _] |
G |
extends readonly any[] = GapsOf<P, [separator: string, str: string]> |
R |
extends unknown = string |
Parameters
| Name | Type |
|---|---|
...p |
P | [separator: string | typeof _, str: string | typeof _] |
Returns
RequiredKeys<ObjectOf<G>> extends never ? R : Curry<(...p: G) => R>
Defined in
node_modules/ts-toolbelt/out/Function/Curry.d.ts:77
beforeFirst
▸ beforeFirst<P, G, R>(...p): RequiredKeys<ObjectOf<G>> extends never ? R : Curry<(...p: G) => R>
Curry a Function
Example
import {F} from 'ts-toolbelt'
/// If you are looking for creating types for `curry`
/// It handles placeholders and variable arguments
declare function curry<Fn extends F.Function>(fn: Fn): F.Curry<Fn>
Type parameters
| Name | Type |
|---|---|
P |
extends [separator: string | typeof _, str: string | typeof _] |
G |
extends readonly any[] = GapsOf<P, [separator: string, str: string]> |
R |
extends unknown = string |
Parameters
| Name | Type |
|---|---|
...p |
P | [separator: string | typeof _, str: string | typeof _] |
Returns
RequiredKeys<ObjectOf<G>> extends never ? R : Curry<(...p: G) => R>
Defined in
node_modules/ts-toolbelt/out/Function/Curry.d.ts:77
beforeFirstWord
▸ beforeFirstWord<P, G, R>(...p): RequiredKeys<ObjectOf<G>> extends never ? R : Curry<(...p: G) => R>
Curry a Function
Example
import {F} from 'ts-toolbelt'
/// If you are looking for creating types for `curry`
/// It handles placeholders and variable arguments
declare function curry<Fn extends F.Function>(fn: Fn): F.Curry<Fn>
Type parameters
| Name | Type |
|---|---|
P |
extends [str: string | typeof _] |
G |
extends readonly any[] = GapsOf<P, [str: string]> |
R |
extends unknown = string |
Parameters
| Name | Type |
|---|---|
...p |
P | [str: string | typeof _] |
Returns
RequiredKeys<ObjectOf<G>> extends never ? R : Curry<(...p: G) => R>
Defined in
node_modules/ts-toolbelt/out/Function/Curry.d.ts:77
endsWith
▸ endsWith<P, G, R>(...p): RequiredKeys<ObjectOf<G>> extends never ? R : Curry<(...p: G) => R>
Curry a Function
Example
import {F} from 'ts-toolbelt'
/// If you are looking for creating types for `curry`
/// It handles placeholders and variable arguments
declare function curry<Fn extends F.Function>(fn: Fn): F.Curry<Fn>
Type parameters
| Name | Type |
|---|---|
P |
extends [needle: string | typeof _, haystack: string | typeof _] |
G |
extends readonly any[] = GapsOf<P, [needle: string, haystack: string]> |
R |
extends unknown = boolean |
Parameters
| Name | Type |
|---|---|
...p |
P | [needle: string | typeof _, haystack: string | typeof _] |
Returns
RequiredKeys<ObjectOf<G>> extends never ? R : Curry<(...p: G) => R>
Defined in
node_modules/ts-toolbelt/out/Function/Curry.d.ts:77
ltrim
▸ ltrim<P, G, R>(...p): RequiredKeys<ObjectOf<G>> extends never ? R : Curry<(...p: G) => R>
Trims characters from the left side of a string.
Type parameters
| Name | Type |
|---|---|
P |
extends [cutset: string | typeof _, str: string | typeof _] |
G |
extends readonly any[] = GapsOf<P, [cutset: string, str: string]> |
R |
extends unknown = string |
Parameters
| Name | Type |
|---|---|
...p |
P | [cutset: string | typeof _, str: string | typeof _] |
Returns
RequiredKeys<ObjectOf<G>> extends never ? R : Curry<(...p: G) => R>
Defined in
node_modules/ts-toolbelt/out/Function/Curry.d.ts:77
removeFirstWord
▸ removeFirstWord(str): string
Parameters
| Name | Type |
|---|---|
str |
string |
Returns
string
Defined in
removeWordsFromBeginning
▸ removeWordsFromBeginning<P, G, R>(...p): RequiredKeys<ObjectOf<G>> extends never ? R : Curry<(...p: G) => R>
Curry a Function
Example
import {F} from 'ts-toolbelt'
/// If you are looking for creating types for `curry`
/// It handles placeholders and variable arguments
declare function curry<Fn extends F.Function>(fn: Fn): F.Curry<Fn>
Type parameters
| Name | Type |
|---|---|
P |
extends [maxChars: number | typeof _, str: string | typeof _] |
G |
extends readonly any[] = GapsOf<P, [maxChars: number, str: string]> |
R |
extends unknown = unknown |
Parameters
| Name | Type |
|---|---|
...p |
P | [maxChars: number | typeof _, str: string | typeof _] |
Returns
RequiredKeys<ObjectOf<G>> extends never ? R : Curry<(...p: G) => R>
Defined in
node_modules/ts-toolbelt/out/Function/Curry.d.ts:77
rtrim
▸ rtrim<P, G, R>(...p): RequiredKeys<ObjectOf<G>> extends never ? R : Curry<(...p: G) => R>
Curry a Function
Example
import {F} from 'ts-toolbelt'
/// If you are looking for creating types for `curry`
/// It handles placeholders and variable arguments
declare function curry<Fn extends F.Function>(fn: Fn): F.Curry<Fn>
Type parameters
| Name | Type |
|---|---|
P |
extends [cutset: string | typeof _, str: string | typeof _] |
G |
extends readonly any[] = GapsOf<P, [cutset: string, str: string]> |
R |
extends unknown = string |
Parameters
| Name | Type |
|---|---|
...p |
P | [cutset: string | typeof _, str: string | typeof _] |
Returns
RequiredKeys<ObjectOf<G>> extends never ? R : Curry<(...p: G) => R>
Defined in
node_modules/ts-toolbelt/out/Function/Curry.d.ts:77
shorten
▸ shorten<P, G, R>(...p): RequiredKeys<ObjectOf<G>> extends never ? R : Curry<(...p: G) => R>
Curry a Function
Example
import {F} from 'ts-toolbelt'
/// If you are looking for creating types for `curry`
/// It handles placeholders and variable arguments
declare function curry<Fn extends F.Function>(fn: Fn): F.Curry<Fn>
Type parameters
| Name | Type |
|---|---|
P |
extends [maxChars: number | typeof _, strategy: any] |
G |
extends readonly any[] = GapsOf<P, [maxChars: number, strategy: any]> |
R |
extends unknown = (init: unknown) => unknown |
Parameters
| Name | Type |
|---|---|
...p |
P | [maxChars: number | typeof _, strategy: any] |
Returns
RequiredKeys<ObjectOf<G>> extends never ? R : Curry<(...p: G) => R>
Defined in
node_modules/ts-toolbelt/out/Function/Curry.d.ts:77
shorterThan
▸ shorterThan<P, G, R>(...p): RequiredKeys<ObjectOf<G>> extends never ? R : Curry<(...p: G) => R>
Curry a Function
Example
import {F} from 'ts-toolbelt'
/// If you are looking for creating types for `curry`
/// It handles placeholders and variable arguments
declare function curry<Fn extends F.Function>(fn: Fn): F.Curry<Fn>
Type parameters
| Name | Type |
|---|---|
P |
extends [maxChars: number | typeof _, str: string | typeof _] |
G |
extends readonly any[] = GapsOf<P, [maxChars: number, str: string]> |
R |
extends unknown = boolean |
Parameters
| Name | Type |
|---|---|
...p |
P | [maxChars: number | typeof _, str: string | typeof _] |
Returns
RequiredKeys<ObjectOf<G>> extends never ? R : Curry<(...p: G) => R>
Defined in
node_modules/ts-toolbelt/out/Function/Curry.d.ts:77
startsWith
▸ startsWith<P, G, R>(...p): RequiredKeys<ObjectOf<G>> extends never ? R : Curry<(...p: G) => R>
Curry a Function
Example
import {F} from 'ts-toolbelt'
/// If you are looking for creating types for `curry`
/// It handles placeholders and variable arguments
declare function curry<Fn extends F.Function>(fn: Fn): F.Curry<Fn>
Type parameters
| Name | Type |
|---|---|
P |
extends [needle: string | typeof _, haystack: string | typeof _] |
G |
extends readonly any[] = GapsOf<P, [needle: string, haystack: string]> |
R |
extends unknown = boolean |
Parameters
| Name | Type |
|---|---|
...p |
P | [needle: string | typeof _, haystack: string | typeof _] |
Returns
RequiredKeys<ObjectOf<G>> extends never ? R : Curry<(...p: G) => R>
Defined in
node_modules/ts-toolbelt/out/Function/Curry.d.ts:77
trim
▸ trim<P, G, R>(...p): RequiredKeys<ObjectOf<G>> extends never ? R : Curry<(...p: G) => R>
Curry a Function
Example
import {F} from 'ts-toolbelt'
/// If you are looking for creating types for `curry`
/// It handles placeholders and variable arguments
declare function curry<Fn extends F.Function>(fn: Fn): F.Curry<Fn>
Type parameters
| Name | Type |
|---|---|
P |
extends [cutset: string | typeof _, str: string | typeof _] |
G |
extends readonly any[] = GapsOf<P, [cutset: string, str: string]> |
R |
extends unknown = any |
Parameters
| Name | Type |
|---|---|
...p |
P | [cutset: string | typeof _, str: string | typeof _] |
Returns
RequiredKeys<ObjectOf<G>> extends never ? R : Curry<(...p: G) => R>
Defined in
node_modules/ts-toolbelt/out/Function/Curry.d.ts:77