Configuration ​

Server configrations can be specified via option parameters.

import { createRequestHandler } from "@urami/core";

const handler = createRequestHandler({
  remoteDomains: ["httpmemes.netlify.app"],
  allowedDomains: ["svelte-aio.vercel.app"],
  ttl: 1000 * 60 * 60 * 24 * 7,
  storePath: ".urami/images",
});

import { createRequestHandler } from "@urami/core";

const handler = createRequestHandler({
  remoteDomains: ["httpmemes.netlify.app"],
  allowedDomains: ["svelte-aio.vercel.app"],
  ttl: 1000 * 60 * 60 * 24 * 7,
  storePath: ".urami/images",
});

remoteDomains ​

string[] | undefined

List of domains that API will be allowed to optimize. Defaults to unset

From example above, remoteDomains: ['httpmemes.netlify.app'] means that API will only be allowed to optimize images that served from httpmemes.netlify.app.

Unset this option will tell API to optimize all images from everywhere

allowedDomains ​

string[] | undefined

List of domains that allowed to use the API, this will be checked via header Referer

Only applied when process.env.NODE_ENV is set to production. Unset this option will allow anywhere to request image from this API.

## defaultDomain

string | undefined

Default domain to use when domain is not specified in URL. Defaults to undefined

ttl ​

number

Time until images will become invalidated, defaults to 7 days

Values are in milliseconds

storePath ​

string

Directory path to cache optimized images. Defaults to .urami/images

Provided paths will be relative to process.cwd()