Skip to content

Commit

Permalink
docs: small typos (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
danielroe committed Feb 17, 2021
1 parent 8ccdc32 commit 1360a14
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Splits string and joins by PascalCase convention (`foo-bar` => `FooBar`)

**Remarks:**

- If an upper case if followed by other upper case chars (like `FooBAR`), it is preserved
- If an uppercase letter is followed by other uppercase letters (like `FooBAR`), they are preserved

### `camelCase`

Expand All @@ -50,23 +50,23 @@ Splits string and joins by kebab-case convention (`fooBar` => `foo-bar`)

**Remarks:**

- It does **not** preserves case
- It does **not** preserve case

### `snakeCase`

Splits string and joins by snake_case convention (`foo-bar` => `foo_bar`)

### `upperFirst(str)`

Converts first charachter to upper case
Converts first character to upper case

### `lowerFirst(str)`

Converts first charachter to lower case
Converts first character to lower case

### `splitByCase(str, splitters?)`

- Splits string by splitters (default: `['-', '_', '/', '.]`)
- Splits string by the splitters provided (default: `['-', '_', '/', '.]`)
- Splits when case changes from lower to upper (only rising edges)
- Case is preserved in returned value
- Is an irreversible function since splitters are omitted
Expand Down

0 comments on commit 1360a14

Please sign in to comment.