Skip to content

DefineLocaleMessage.md

Latest commit

 

History

History
49 lines (34 loc) · 1.04 KB

DefineLocaleMessage.md

File metadata and controls

49 lines (34 loc) · 1.04 KB
Raw

@intlify/h3

@intlify/h3 / DefineLocaleMessage

Interface: DefineLocaleMessage

The type definition of Locale Message for @intlify/h3 package

Example

// type.d.ts (`.d.ts` file at your app)
import { DefineLocaleMessage } from '@intlify/h3'

declare module '@intlify/h3' {
  export interface DefineLocaleMessage {
    title: string
    menu: {
      login: string
    }
  }
}

Description

The typealias is used to strictly define the type of the Locale message.

Extends

  • LocaleMessage<string>.ResourceSchema

Indexable

[key: string]: LocaleMessageValue<string>

Properties

Property Type Default value Description
hello string 'hello, {name}' -
nest object undefined -
nest.foo object undefined -
nest.foo.bar string 'bar' -
test string undefined Define your locale message schema here