Skip to content

Commit

Permalink
docs(bytes): add missing docs to README (denoland/deno#7885)
Browse files Browse the repository at this point in the history
  • Loading branch information
kt3k authored and caspervonb committed Jan 24, 2021
1 parent b90b081 commit 422315f
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions bytes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,17 @@ hasPrefix(new Uint8Array([0, 1, 2]), new Uint8Array([0, 1])); // returns true
hasPrefix(new Uint8Array([0, 1, 2]), new Uint8Array([1, 2])); // returns false
```

## hasSuffix

Check whether binary array ends with suffix.

```typescript
import { hasSuffix } from "https://deno.land/std@$STD_VERSION/bytes/mod.ts";

hasSuffix(new Uint8Array([0, 1, 2]), new Uint8Array([0, 1])); // returns false
hasSuffix(new Uint8Array([0, 1, 2]), new Uint8Array([1, 2])); // returns true
```

## repeat

Repeat bytes of given binary array and return new one.
Expand All @@ -78,6 +89,24 @@ import { concat } from "https://deno.land/std@$STD_VERSION/bytes/mod.ts";
concat(new Uint8Array([1, 2]), new Uint8Array([3, 4])); // returns Uint8Array(4) [ 1, 2, 3, 4 ]
```

## contains

Check source array contains pattern array.

```typescript
import { contains } from "https://deno.land/std@$STD_VERSION/bytes/mod.ts";

contains(
new Uint8Array([1, 2, 0, 1, 2, 0, 2, 1, 3]),
new Uint8Array([0, 1, 2]),
); // => returns true

contains(
new Uint8Array([1, 2, 0, 1, 2, 0, 2, 1, 3]),
new Uint8Array([2, 2]),
); // => returns false
```

## copyBytes

Copy bytes from one binary array to another.
Expand Down

0 comments on commit 422315f

Please sign in to comment.