Skip to content

Commit

Permalink
docs: fix some typos
Browse files Browse the repository at this point in the history
closes #282
  • Loading branch information
Kikobeats committed Mar 8, 2023
1 parent 17f2038 commit c6a47e4
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 54 deletions.
22 changes: 5 additions & 17 deletions docs/pages/packages/feature-detector.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { Tabs, Tab } from '../../components/tabs'

The **@edge-runtime/feature-detector** package contains utilities to analyze code running on the edge and its used low-level APIs.

It leverages the excellent [ts-morph](https://ts-morph.com/) package, which is a wrapper around TypeScript compiler API to navigate its Abstract Syntaxt Tree (AST).
It leverages the excellent [ts-morph](https://ts-morph.com/) package, which is a wrapper around TypeScript compiler API to navigate its Abstract Syntax Tree (AST).

It can analyse JavaScript and TypeScript code.

Expand All @@ -15,22 +15,10 @@ It can analyse JavaScript and TypeScript code.

## Installation

<Tabs items={['npm', 'yarn', 'pnpm']} storageKey="selected-pkg-manager">
<Tab>
```sh
npm install @edge-runtime/feature-detector --save
```
</Tab>
<Tab>
```sh
yarn add @edge-runtime/feature-detector
```
</Tab>
<Tab>
```sh
pnpm install @edge-runtime/feature-detector --save
```
</Tab>
<Tabs items={['npm', 'yarn', 'pnpm']} storageKey='selected-pkg-manager'>
<Tab>```sh npm install @edge-runtime/feature-detector --save ```</Tab>
<Tab>```sh yarn add @edge-runtime/feature-detector ```</Tab>
<Tab>```sh pnpm install @edge-runtime/feature-detector --save ```</Tab>
</Tabs>

This package includes built-in TypeScript support.
Expand Down
22 changes: 5 additions & 17 deletions docs/pages/packages/format.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,10 @@ It follows the [formatter spec](https://console.spec.whatwg.org/#formatter) and

## Installation

<Tabs items={['npm', 'yarn', 'pnpm']} storageKey="selected-pkg-manager">
<Tab>
```sh
npm install @edge-runtime/format --save
```
</Tab>
<Tab>
```sh
yarn add @edge-runtime/format
```
</Tab>
<Tab>
```sh
pnpm install @edge-runtime/format --save
```
</Tab>
<Tabs items={['npm', 'yarn', 'pnpm']} storageKey='selected-pkg-manager'>
<Tab>```sh npm install @edge-runtime/format --save ```</Tab>
<Tab>```sh yarn add @edge-runtime/format ```</Tab>
<Tab>```sh pnpm install @edge-runtime/format --save ```</Tab>
</Tabs>

This package includes built-in TypeScript support.
Expand Down Expand Up @@ -108,6 +96,6 @@ The default behavior is `error.toString()`.

##### customInspectSymbol?: symbol

It sets the symbold to be used for priting custom behavior.
It sets the symbol to be used for printing custom behavior.

The default value is `edge-runtime.inspect.custom`.
4 changes: 2 additions & 2 deletions docs/pages/packages/node-utils.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -110,14 +110,14 @@ It needs globals Web contstructor a [dependencies](#dependencies-object), as wel
Builds a transformer function to build a fetch event from a web [Request].
The returned event is linked to provided request, and has a mocked [waitUntil()](https://developer.mozilla.org/en-US/docs/Web/API/ExtendableEvent/waitUntil) method, which throws on access.

It needs globals Web contstructor a [dependencies](#dependencies-object).
It needs globals Web constructor a [dependencies](#dependencies-object).

### toOutgoingHeaders(headers: Headers): OutgoingHttpHeaders

Turns Web [Request.headers](https://developer.mozilla.org/en-US/docs/Web/API/Request/headers) into
Node.js `ServerResponse` [OutgoingHttpHeaders](https://nodejs.org/api/http.html#responsegetheaders).

Includes `set-cookie` special handling, spliting multiple values when relevant.
Includes `set-cookie` special handling, splitting multiple values when relevant.

### buildToHeaders(dependencies): toHeaders(nodeHeaders: IncomingHttpHeaders): Headers

Expand Down
22 changes: 5 additions & 17 deletions docs/pages/packages/ponyfill.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,14 @@ The **@edge-runtime/ponyfill** package helps to have the Edge Runtime APIs avail
- When running on Edge Runtime, no polyfills will be loaded, and the native implementations will be used.
- When running on Node.js runtimes, this package will load the polyfills from [@edge-runtime/primitives](/packages/primitives).

Note this is just necessary if you want to run the same code accross diferent environments.
Note this is just necessary if you want to run the same code across different environments.

## Installation

<Tabs items={['npm', 'yarn', 'pnpm']} storageKey="selected-pkg-manager">
<Tab>
```sh
npm install @edge-runtime/ponyfill --save
```
</Tab>
<Tab>
```sh
yarn add @edge-runtime/ponyfill
```
</Tab>
<Tab>
```sh
pnpm install @edge-runtime/ponyfill --save
```
</Tab>
<Tabs items={['npm', 'yarn', 'pnpm']} storageKey='selected-pkg-manager'>
<Tab>```sh npm install @edge-runtime/ponyfill --save ```</Tab>
<Tab>```sh yarn add @edge-runtime/ponyfill ```</Tab>
<Tab>```sh pnpm install @edge-runtime/ponyfill --save ```</Tab>
</Tabs>

This package includes built-in TypeScript support.
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/packages/primitives.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The **@edge-runtime/primitives** package contains all the Web Standard APIs that

These APIs are a subset of modern browser APIs (such as `fetch`, `URLPattern`, `structuredClone`, etc).

See full list is availabe at [Edge Runtime APIs](/features/available-apis).
See full list is available at [Edge Runtime APIs](/features/available-apis).

## Installation

Expand Down

1 comment on commit c6a47e4

@vercel
Copy link

@vercel vercel bot commented on c6a47e4 Mar 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

edge-runtime – ./

edge-runtime.vercel.app
edge-runtime.vercel.sh
edge-runtime-git-main.vercel.sh

Please sign in to comment.