Skip to content

Commit

Permalink
Add link to types
Browse files Browse the repository at this point in the history
  • Loading branch information
benmccann committed Jul 8, 2021
1 parent 0861cbe commit 5d075ae
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion documentation/docs/80-adapter-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Writing an Adapter

We recommend [looking at the source for an adapter](https://github.com/sveltejs/kit/tree/master/packages) to a platform similar to yours and copying it as a starting point.

Adapters must implement the following API:
Adapters packages must implement the following API, which creates an `Adapter`:
```
/**
* @param {AdapterSpecificOptions} options
Expand All @@ -19,6 +19,8 @@ export default function () {
}
```

The types for `Adapter` and its parameters are available in [types/config.d.ts](https://github.com/sveltejs/kit/blob/master/packages/kit/types/config.d.ts).

Within the `adapt` method, there are a number of things that an adapter should do:
- Clear out the build directory
- Provide code that:
Expand Down

0 comments on commit 5d075ae

Please sign in to comment.