Skip to content

Options

locale

The language and region the page sees, such as en-US or de-DE.

Type
string
Default
Browser default
On this page

OverviewLink to this section

Sets the language and region the browser reports, in the Accept-Language header and to scripts, and the way it formats dates and numbers. Sites that choose their language automatically render in it.

Use a language tag such as en-US, de-DE, fr-FR or ja-JP. An empty string is ignored and the browser default is used.

ExampleLink to this section

The same request with the SDK, with cURL and as the raw JSON body.

screenshot.ts
import { Url2Image } from '@url2image/sdk'

const { success, data, message } = await Url2Image({
    url: 'https://example.com',
    token: process.env.URL2IMAGE_TOKEN,
    options: {
        locale: 'de-DE'
    }
})

Every option, grouped, is in the options overview.

Something unclear or missing on this page?

Tell us
Made with Modulify