Функции
Функция | Описание |
---|---|
defineBoolean(имя, параметры) | Объявите логический параметр. |
defineInt(имя, параметры) | Объявите целочисленный параметр. |
defineList(имя, параметры) | Объявите параметр списка. |
defineSecret(имя) | Объявляет секретный параметр, значения которого будут сохраняться только в Cloud Secret Manager. Секреты хранятся внутри в виде байтовых строк. Используйте ПарамОпционс. as обеспечить подсказку типа во время разрешения параметров. |
defineString (имя, параметры) | Объявите строковый параметр. |
Классы
Сорт | Описание |
---|---|
Выражение |
Переменные
Переменная | Описание |
---|---|
URL базы данных | Встроенный параметр, который преобразуется в URL-адрес базы данных RTDB по умолчанию, связанный с проектом, без запроса средства развертывания. Пустая строка, если ее нет. |
объявленные параметры | |
gcloudProject | Встроенный параметр, который преобразуется в идентификатор облачного проекта без запроса средства развертывания. |
идентификатор проекта | Встроенный параметр, который преобразуется в идентификатор облачного проекта, связанный с проектом, без запроса средства развертывания. |
хранилищеВедро | Встроенный параметр, который разрешает сегмент облачного хранилища, связанный с функцией, без запроса развертывателя. Пустая строка, если не определена. |
Введите псевдонимы
Введите псевдоним | Описание |
---|---|
ПарамОпции | Параметры конфигурации, которые можно использовать для настройки поведения подсказок Param. |
параметры.defineBoolean()
Объявите логический параметр.
Подпись:
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
Параметры
Параметр | Тип | Описание |
---|---|---|
имя | нить | Имя переменной среды, которую следует использовать для загрузки параметра. |
параметры | ПарамОпции <логическое значение> | Варианты конфигурации параметра. |
Возврат:
BooleanParam
Параметр с boolean
типом возврата для .value
.
параметры.defineInt()
Объявите целочисленный параметр.
Подпись:
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
Параметры
Параметр | Тип | Описание |
---|---|---|
имя | нить | Имя переменной среды, которую следует использовать для загрузки параметра. |
параметры | ПарамОпции <номер> | Варианты настройки параметра. |
Возврат:
ИнтПарам
Параметр с возвращаемым number
типа для .value
.
параметры.defineList()
Объявите параметр списка.
Подпись:
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
Параметры
Параметр | Тип | Описание |
---|---|---|
имя | нить | Имя переменной среды, которую следует использовать для загрузки параметра. |
параметры | ПарамОпции <строка[]> | Варианты настройки параметра. |
Возврат:
СписокПарам
Параметр с возвращаемым типом string[]
для .value
.
параметры.defineSecret()
Объявляет секретный параметр, значения которого будут сохраняться только в Cloud Secret Manager. Секреты хранятся внутри в виде байтовых строк. Используйте ПарамОпционс. as
обеспечить подсказку типа во время разрешения параметров.
Подпись:
export declare function defineSecret(name: string): SecretParam;
Параметры
Параметр | Тип | Описание |
---|---|---|
имя | нить | Имя переменной среды, которую следует использовать для загрузки параметра. |
Возврат:
Секретные параметры
Параметр со string
типом возврата для .value
.
параметры.defineString()
Объявите строковый параметр.
Подпись:
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
Параметры
Параметр | Тип | Описание |
---|---|---|
имя | нить | Имя переменной среды, которую следует использовать для загрузки параметра. |
параметры | ПарамОпции <строка> | Варианты настройки параметра. |
Возврат:
СтроковыйПарам
Параметр со string
типом возврата для .value
.
params.databaseURL
Встроенный параметр, который преобразуется в URL-адрес базы данных RTDB по умолчанию, связанный с проектом, без запроса средства развертывания. Пустая строка, если ее нет.
Подпись:
databaseURL: Param<string>
params.declaredParams
Подпись:
declaredParams: SecretOrExpr[]
params.gcloudProject
Встроенный параметр, который преобразуется в идентификатор облачного проекта без запроса средства развертывания.
Подпись:
gcloudProject: Param<string>
параметры.projectID
Встроенный параметр, который преобразуется в идентификатор облачного проекта, связанный с проектом, без запроса средства развертывания.
Подпись:
projectID: Param<string>
params.storageBucket
Встроенный параметр, который разрешает сегмент облачного хранилища, связанный с функцией, без запроса развертывателя. Пустая строка, если не определена.
Подпись:
storageBucket: Param<string>
параметры.ParamOptions
Параметры конфигурации, которые можно использовать для настройки поведения подсказок Param.
Подпись:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;