strings/docs/modules.md

@sbrow/strings / Exports

@sbrow/strings

Table of contents

Functions

• endsWith
• ltrim
• startsWith

Functions

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>

Function

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

---

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>

Function

Defined in

node_modules/ts-toolbelt/out/Function/Curry.d.ts:77