mirror of
https://github.com/sbrow/strings.git
synced 2025-12-29 15:17:38 -05:00
feat: Added docs.
This commit is contained in:
1
docs/.nojekyll
Normal file
1
docs/.nojekyll
Normal file
@@ -0,0 +1 @@
|
||||
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
|
||||
1
docs/README.md
Normal file
1
docs/README.md
Normal file
@@ -0,0 +1 @@
|
||||
@sbrow/strings / [Exports](modules.md)
|
||||
125
docs/modules.md
Normal file
125
docs/modules.md
Normal file
@@ -0,0 +1,125 @@
|
||||
[@sbrow/strings](README.md) / Exports
|
||||
|
||||
# @sbrow/strings
|
||||
|
||||
## Table of contents
|
||||
|
||||
### Functions
|
||||
|
||||
- [endsWith](modules.md#endswith)
|
||||
- [ltrim](modules.md#ltrim)
|
||||
- [startsWith](modules.md#startswith)
|
||||
|
||||
## Functions
|
||||
|
||||
### endsWith
|
||||
|
||||
▸ **endsWith**<`P`, `G`, `R`\>(`...p`): `RequiredKeys`<`ObjectOf`<`G`\>\> extends `never` ? `R` : `Curry`<(...`p`: `G`) => `R`\>
|
||||
|
||||
Curry a [[Function]]
|
||||
|
||||
**`Example`**
|
||||
|
||||
```ts
|
||||
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`**
|
||||
|
||||
```ts
|
||||
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
|
||||
Reference in New Issue
Block a user