Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Thanga-Ganapathy committed Mar 25, 2024
1 parent 1727c15 commit b9e7b07
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 15 deletions.
5 changes: 5 additions & 0 deletions .changeset/red-mugs-return.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@opentf/std": patch
---

Updated readme.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ await sleep(1000); // It suspends the exection for 1 second.
- [compact](https://js-std.pages.dev/Array/compact)
- [countBy](https://js-std.pages.dev/Array/countBy)
- [diff](https://js-std.pages.dev/Array/diff)
- [drop](https://js-std.pages.dev/Array/drop)
- [groupBy](https://js-std.pages.dev/Array/groupBy)
- [intersection](https://js-std.pages.dev/Array/intersection)
- [max](https://js-std.pages.dev/Array/max)
Expand All @@ -106,6 +107,7 @@ await sleep(1000); // It suspends the exection for 1 second.
- [sort](https://js-std.pages.dev/Array/sort)
- [sortBy](https://js-std.pages.dev/Array/sortBy)
- [symDiff](https://js-std.pages.dev/Array/symDiff)
- [take](https://js-std.pages.dev/Array/take)
- [union](https://js-std.pages.dev/Array/union)
- [uniq](https://js-std.pages.dev/Array/uniq)

Expand Down
2 changes: 0 additions & 2 deletions apps/docs/pages/Array/drop.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ It is loosely based on the experimental [Iterator.prototype.drop()](https://deve
</Callout>

**Related**
- [dropRight](/Array/dropRight)
- [take](/Array/take)
- [takeRight](/Array/takeRight)

## Syntax

Expand Down
4 changes: 1 addition & 3 deletions apps/docs/pages/Array/take.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ It is loosely based on the experimental [Iterator.prototype.take()](https://deve
</Callout>

**Related**
- [dropRight](/Array/dropRight)
- [take](/Array/take)
- [takeRight](/Array/takeRight)
- [drop](/Array/drop)

## Syntax

Expand Down
22 changes: 12 additions & 10 deletions packages/std/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<div align="center">

# Utils
# JavaScript Standard Library

[![Build](https://github.com/open-tech-foundation/js-std/actions/workflows/build.yml/badge.svg)](https://github.com/open-tech-foundation/js-std/actions/workflows/build.yml)

Expand Down Expand Up @@ -55,28 +55,28 @@ import {
isEql,
isEqlArr,
sleep,
} from '@opentf/std';
} from "@opentf/std";

isNum(NaN); //=> false

pascalCase('pascal case'); //=> PascalCase
pascalCase("pascal case"); //=> PascalCase

sort([1, 10, 21, 2], 'desc'); //=> [ 21, 10, 2, 1 ]
sort([1, 10, 21, 2], "desc"); //=> [ 21, 10, 2, 1 ]

const obj = {
a: 1,
b: 'abc',
c: new Map([['key', 'val']]),
b: "abc",
c: new Map([["key", "val"]]),
};
clone(obj); // It returns deeply cloned value.

const mapA = new Map([
['a', 1],
['b', 2],
["a", 1],
["b", 2],
]);
const mapB = new Map([
['b', 2],
['a', 1],
["b", 2],
["a", 1],
]);
isEql(mapA, mapB); //=> false

Expand All @@ -97,6 +97,7 @@ await sleep(1000); // It suspends the exection for 1 second.
- [compact](https://js-std.pages.dev/Array/compact)
- [countBy](https://js-std.pages.dev/Array/countBy)
- [diff](https://js-std.pages.dev/Array/diff)
- [drop](https://js-std.pages.dev/Array/drop)
- [groupBy](https://js-std.pages.dev/Array/groupBy)
- [intersection](https://js-std.pages.dev/Array/intersection)
- [max](https://js-std.pages.dev/Array/max)
Expand All @@ -106,6 +107,7 @@ await sleep(1000); // It suspends the exection for 1 second.
- [sort](https://js-std.pages.dev/Array/sort)
- [sortBy](https://js-std.pages.dev/Array/sortBy)
- [symDiff](https://js-std.pages.dev/Array/symDiff)
- [take](https://js-std.pages.dev/Array/take)
- [union](https://js-std.pages.dev/Array/union)
- [uniq](https://js-std.pages.dev/Array/uniq)

Expand Down

0 comments on commit b9e7b07

Please sign in to comment.