함수
함수 | 설명 |
---|---|
defineboolean(이름, 옵션) | 불리언 매개변수를 선언합니다. |
defineInt(이름, 옵션) | 정수 매개변수를 선언합니다. |
defineList(이름, 옵션) | 목록 매개변수를 선언합니다. |
defineSecret(이름) | Cloud Secret Manager에서만 값을 유지하는 보안 비밀 매개변수를 선언합니다. 보안 비밀은 내부에 바이트 문자열로 저장됩니다. 매개변수 확인 중에 유형 힌트를 제공하려면 ParamOptions.as 를 사용합니다. |
defineString(이름, 옵션) | 문자열 매개변수를 선언합니다. |
클래스
클래스 | 설명 |
---|---|
표현식 |
변수
변수 | 설명 |
---|---|
데이터베이스 URL | 배포자에게 메시지를 표시하지 않고 프로젝트와 연결된 기본 RTDB 데이터베이스 URL로 확인되는 기본 제공 매개변수입니다. 없는 경우 빈 문자열입니다. |
DeclaredParams | |
gcloud프로젝트 | 배포자에게 메시지를 표시하지 않고 Cloud 프로젝트 ID로 확인되는 기본 제공 매개변수입니다. |
프로젝트 ID | 배포자에게 메시지를 표시하지 않고 프로젝트와 연결된 Cloud 프로젝트 ID로 확인되는 기본 제공 매개변수입니다. |
저장소 버킷 | 배포자에게 메시지를 표시하지 않고 함수와 연결된 Cloud Storage 버킷으로 확인되는 기본 제공 매개변수입니다. 정의되지 않은 경우 빈 문자열입니다. |
유형 별칭
별칭 입력 | 설명 |
---|---|
매개변수 옵션 | Param의 메시지 표시 동작을 사용자 지정하는 데 사용할 수 있는 구성 옵션입니다. |
params.defineboolean()
불리언 매개변수를 선언합니다.
서명:
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
name | 문자열 | 매개변수를 로드하는 데 사용할 환경 변수의 이름입니다. |
옵션 | ParamOptions<boolean> | 매개변수의 구성 옵션입니다. |
반환:
부울 매개변수
.value
의 boolean
반환 유형이 있는 매개변수입니다.
params.defineInt()
정수 매개변수를 선언합니다.
서명:
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
name | 문자열 | 매개변수를 로드하는 데 사용할 환경 변수의 이름입니다. |
옵션 | ParamOptions<숫자> | 매개변수의 구성 옵션입니다. |
반환:
IntParam
.value
의 number
반환 유형이 있는 매개변수입니다.
params.defineList()
목록 매개변수를 선언합니다.
서명:
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
name | 문자열 | 매개변수를 로드하는 데 사용할 환경 변수의 이름입니다. |
옵션 | ParamOptions<string[]> | 매개변수의 구성 옵션입니다. |
반환:
ListParam
.value
의 string[]
반환 유형이 있는 매개변수입니다.
params.defineSecret()
Cloud Secret Manager에서만 값을 유지하는 보안 비밀 매개변수를 선언합니다. 보안 비밀은 내부에 바이트 문자열로 저장됩니다. 매개변수 확인 중에 유형 힌트를 제공하려면 ParamOptions.as
를 사용합니다.
서명:
export declare function defineSecret(name: string): SecretParam;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
name | 문자열 | 매개변수를 로드하는 데 사용할 환경 변수의 이름입니다. |
반환:
SecretParam
.value
의 string
반환 유형이 있는 매개변수입니다.
params.defineString()
문자열 매개변수를 선언합니다.
서명:
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
name | 문자열 | 매개변수를 로드하는 데 사용할 환경 변수의 이름입니다. |
옵션 | ParamOptions<string> | 매개변수의 구성 옵션입니다. |
반환:
문자열 매개변수
.value
의 string
반환 유형이 있는 매개변수입니다.
params.databaseURL
배포자에게 메시지를 표시하지 않고 프로젝트와 연결된 기본 RTDB 데이터베이스 URL로 확인되는 기본 제공 매개변수입니다. 없는 경우 빈 문자열입니다.
서명:
databaseURL: Param<string>
params.DeclaredParams
서명:
declaredParams: SecretOrExpr[]
params.gcloudProject
배포자에게 메시지를 표시하지 않고 Cloud 프로젝트 ID로 확인되는 기본 제공 매개변수입니다.
서명:
gcloudProject: Param<string>
params.projectID
배포자에게 메시지를 표시하지 않고 프로젝트와 연결된 Cloud 프로젝트 ID로 확인되는 기본 제공 매개변수입니다.
서명:
projectID: Param<string>
params.storageBucket
배포자에게 메시지를 표시하지 않고 함수와 연결된 Cloud Storage 버킷으로 확인되는 기본 제공 매개변수입니다. 정의되지 않은 경우 빈 문자열입니다.
서명:
storageBucket: Param<string>
params.ParamOptions
Param의 메시지 표시 동작을 사용자 지정하는 데 사용할 수 있는 구성 옵션입니다.
서명:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;