params namespace

기능

기능 설명
DefineBoolean(이름, 옵션) 부울 매개변수를 선언합니다.
DefineInt(이름, 옵션) 정수 매개변수를 선언합니다.
정의목록(이름, 옵션) 목록 매개변수를 선언합니다.
정의비밀(이름) Cloud Secret Manager에서만 값을 유지하는 비밀 매개변수를 선언합니다. 비밀은 내부적으로 바이트열로 저장됩니다. ParamOptions를 사용하세요. 매개변수 확인 중에 유형 힌트를 제공 as .
정의문자열(이름, 옵션) 문자열 매개변수를 선언합니다.

클래스

수업 설명
표현

변수

변하기 쉬운 설명
데이터베이스URL 배포자에게 메시지를 표시하지 않고 프로젝트와 연결된 기본 RTDB 데이터베이스 URL을 확인하는 내장 매개변수입니다. 존재하지 않는 경우 빈 문자열입니다.
선언된 매개변수
gcloud프로젝트 배포자에게 메시지를 표시하지 않고 Cloud 프로젝트 ID를 확인하는 기본 매개변수입니다.
프로젝트 ID 배포자에게 메시지를 표시하지 않고 프로젝트와 연결된 Cloud 프로젝트 ID를 확인하는 기본 매개변수입니다.
저장통 배포자에게 메시지를 표시하지 않고 함수와 연결된 Cloud Storage 버킷을 확인하는 기본 제공 매개변수입니다. 정의되지 않은 경우 빈 문자열입니다.

유형 별칭

유형 별칭 설명
매개변수옵션 Param의 프롬프트 동작을 사용자 정의하는 데 사용할 수 있는 구성 옵션입니다.

params.defineBoolean()

부울 매개변수를 선언합니다.

서명:

export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;

매개변수

매개변수 유형 설명
이름 매개변수를 로드하는 데 사용할 환경 변수의 이름입니다.
옵션 매개변수옵션 <부울> 매개변수에 대한 구성 옵션입니다.

보고:

BooleanParam

.value 에 대한 boolean 반환 유형이 있는 Param .

params.defineInt()

정수 매개변수를 선언합니다.

서명:

export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;

매개변수

매개변수 유형 설명
이름 매개변수를 로드하는 데 사용할 환경 변수의 이름입니다.
옵션 매개변수옵션 <번호> 매개변수에 대한 구성 옵션입니다.

보고:

IntParam

.value 에 대한 number 반환 유형이 있는 Param .

params.defineList()

목록 매개변수를 선언합니다.

서명:

export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;

매개변수

매개변수 유형 설명
이름 매개변수를 로드하는 데 사용할 환경 변수의 이름입니다.
옵션 매개변수옵션 <문자열[]> 매개변수에 대한 구성 옵션입니다.

보고:

ListParam

.value 에 대한 string[] 반환 유형이 있는 Param .

params.defineSecret()

Cloud Secret Manager에서만 값을 유지하는 비밀 매개변수를 선언합니다. 비밀은 내부적으로 바이트열로 저장됩니다. ParamOptions를 사용하세요. 매개변수 확인 중에 유형 힌트를 제공 as .

서명:

export declare function defineSecret(name: string): SecretParam;

매개변수

매개변수 유형 설명
이름 매개변수를 로드하는 데 사용할 환경 변수의 이름입니다.

보고:

SecretParam

.value 에 대한 string 반환 유형이 있는 Param .

params.defineString()

문자열 매개변수를 선언합니다.

서명:

export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;

매개변수

매개변수 유형 설명
이름 매개변수를 로드하는 데 사용할 환경 변수의 이름입니다.
옵션 매개변수옵션 <문자열> 매개변수에 대한 구성 옵션입니다.

보고:

StringParam

.value 에 대한 string 반환 유형이 있는 Param .

params.databaseURL

배포자에게 메시지를 표시하지 않고 프로젝트와 연결된 기본 RTDB 데이터베이스 URL을 확인하는 내장 매개변수입니다. 존재하지 않는 경우 빈 문자열입니다.

서명:

databaseURL: Param<string>

params.declaredParams

서명:

declaredParams: SecretOrExpr[]

params.gcloud프로젝트

배포자에게 메시지를 표시하지 않고 Cloud 프로젝트 ID를 확인하는 기본 매개변수입니다.

서명:

gcloudProject: Param<string>

params.프로젝트ID

배포자에게 메시지를 표시하지 않고 프로젝트와 연결된 Cloud 프로젝트 ID를 확인하는 기본 매개변수입니다.

서명:

projectID: Param<string>

params.storageBucket

배포자에게 메시지를 표시하지 않고 함수와 연결된 Cloud Storage 버킷을 확인하는 기본 매개변수입니다. 정의되지 않은 경우 빈 문자열입니다.

서명:

storageBucket: Param<string>

params.Param옵션

Param의 프롬프트 동작을 사용자 정의하는 데 사용할 수 있는 구성 옵션입니다.

서명:

export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;