Getting Started

Use in your project

Install Scarlett as a dependency using NPM:

npm i scarlett

or if you're using Yarn:

yarn add scarlett

then import it:

import { createRestClient } from "scarlett"

Use from CDN

You can use Scarlett from a CDN using a script tag:

<script type src="https://unpkg.com/scarlett@2/lib/index.js"></script>

or just import it in a Javascript module file:

import { createRestClient } from "https://unpkg.com/scarlett@2/lib/index.js"

Importmap

Configure an alias in the script tag:

<script type="importmap">
  {
    "imports": {
      "scarlett": "https://unpkg.com/scarlett@2/lib/index.js"
    }
  }
</script>

then import it in a Javascript module file:

import { createRestClient } from "scarlett"

For more details about this feature, please visit the official importmap documentation.

Usage

Once installed, you can choose what API Style to use:

Using Functional API

import { createRestClient } from `scarlett`

const useRestClient = createRestClient({
	host: `https://server.com`,
	responseType: `text`
})
const { get } = useRestClient()
const { data, status } = await get<string>(`path`)
console.log(data) // inferred as string or undefined

See the full Functional API Usage guide.

Using Class API

import { RestClient } from `scarlett`

const client = new RestClient({
	host: `https://server.com`,
	responseType: `text`
})
const response = await client.get<string>(`path`)
console.log(response.data) // inferred as string or undefined

See the full Class API Usage guide.

---

Visit the API Styles section to know more about it.