기능
| 기능 | 설명 |
|---|---|
| DefineBoolean(이름, 옵션) | 부울 매개변수를 선언합니다. |
| DefineInt(이름, 옵션) | 정수 매개변수를 선언합니다. |
| 정의목록(이름, 옵션) | 목록 매개변수를 선언합니다. |
| 정의비밀(이름) | Cloud Secret Manager에서만 값을 유지하는 비밀 매개변수를 선언합니다. 비밀은 내부적으로 바이트열로 저장됩니다. 매개변수 확인 중에 유형 힌트를 제공하려면 ParamOptions.as 사용하십시오. |
| 정의문자열(이름, 옵션) | 문자열 매개변수를 선언합니다. |
| 다중선택(옵션) | 일련의 값에서 다중 선택 입력을 만듭니다. |
| 다중선택(옵션) | 레이블 맵에서 값까지 다중 선택 입력을 만듭니다. |
| 선택(옵션) | 일련의 값에서 선택 입력을 만듭니다. |
| 선택(옵션WithLabels) | 레이블과 값의 맵에서 선택 입력을 만듭니다. |
클래스
| 수업 | 설명 |
|---|---|
| 표현 |
인터페이스
| 상호 작용 | 설명 |
|---|---|
| 다중 선택 입력 | 사용자가 배포 시 대화형으로 미리 준비된 옵션 목록에서 하위 집합을 선택하도록 하여 매개변수 값을 결정하도록 지정합니다. string[] 이외의 유형의 매개변수에 사용하면 오류가 발생합니다. |
| 입력 선택 | 사용자가 배포 시 대화형으로 미리 준비된 옵션 목록에서 선택하도록 하여 매개변수 값을 결정하도록 지정합니다. |
| 선택옵션 | 선택 인터페이스에 표시할 값과 선택적으로 사람이 읽을 수 있는 레이블을 포함하는 SelectInput 에 제공되는 옵션 중 하나입니다. |
| 텍스트 입력 | 배포 시 사용자에게 대화형으로 입력하라는 메시지를 표시하여 매개변수 값을 결정하도록 지정합니다. 제공된 유효성 검사Regex와 일치하지 않는 입력이 있는 경우 재시도됩니다. |
변수
| 변하기 쉬운 | 설명 |
|---|---|
| BUCKET_PICKER | 사용자가 선택할 수 있는 프로젝트의 버킷 목록을 자동 생성합니다. |
| 데이터베이스URL | 배포자에게 메시지를 표시하지 않고 프로젝트와 연결된 기본 RTDB 데이터베이스 URL을 확인하는 내장 매개변수입니다. 존재하지 않는 경우 빈 문자열입니다. |
| 선언된 매개변수 | |
| gcloud프로젝트 | 배포자에게 메시지를 표시하지 않고 Cloud 프로젝트 ID를 확인하는 기본 제공 매개변수입니다. |
| 프로젝트ID | 배포자에게 메시지를 표시하지 않고 프로젝트와 연결된 Cloud 프로젝트 ID를 확인하는 기본 제공 매개변수입니다. |
| 저장통 | 배포자에게 메시지를 표시하지 않고 함수와 연결된 Cloud Storage 버킷을 확인하는 기본 제공 매개변수입니다. 정의되지 않은 경우 빈 문자열입니다. |
유형 별칭
| 유형 별칭 | 설명 |
|---|---|
| 매개변수옵션 | 매개변수의 프롬프트 동작을 사용자 정의하는 데 사용할 수 있는 구성 옵션입니다. |
params.defineBoolean()
부울 매개변수를 선언합니다.
서명:
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 이름 | 끈 | 매개변수를 로드하는 데 사용할 환경 변수의 이름입니다. |
| 옵션 | 매개변수옵션 <부울> | 매개변수에 대한 구성 옵션입니다. |
보고:
BooleanParam
.value 에 대한 boolean 반환 유형이 있는 매개변수 .
params.defineInt()
정수 매개변수를 선언합니다.
서명:
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 이름 | 끈 | 매개변수를 로드하는 데 사용할 환경 변수의 이름입니다. |
| 옵션 | 매개변수옵션 <번호> | 매개변수에 대한 구성 옵션입니다. |
보고:
IntParam
.value 에 대한 number 반환 유형이 있는 매개변수 .
params.defineList()
목록 매개변수를 선언합니다.
서명:
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 이름 | 끈 | 매개변수를 로드하는 데 사용할 환경 변수의 이름입니다. |
| 옵션 | 매개변수옵션 <문자열[]> | 매개변수에 대한 구성 옵션입니다. |
보고:
ListParam
.value 에 대한 반환 유형이 string[] 인 매개변수 .
params.defineSecret()
Cloud Secret Manager에서만 값을 유지하는 비밀 매개변수를 선언합니다. 비밀은 내부적으로 바이트열로 저장됩니다. 매개변수 확인 중에 유형 힌트를 제공하려면 ParamOptions.as 사용하십시오.
서명:
export declare function defineSecret(name: string): SecretParam;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 이름 | 끈 | 매개변수를 로드하는 데 사용할 환경 변수의 이름입니다. |
보고:
SecretParam
.value 에 대한 string 반환 유형이 있는 매개변수 .
params.defineString()
문자열 매개변수를 선언합니다.
서명:
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 이름 | 끈 | 매개변수를 로드하는 데 사용할 환경 변수의 이름입니다. |
| 옵션 | 매개변수옵션 <문자열> | 매개변수에 대한 구성 옵션입니다. |
보고:
StringParam
.value 에 대한 string 반환 유형이 있는 매개변수 .
params.다중선택()
일련의 값에서 다중 선택 입력을 만듭니다.
서명:
export declare function multiSelect(options: string[]): MultiSelectInput;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 옵션 | 끈[] |
보고:
params.다중선택()
레이블 맵에서 값까지 다중 선택 입력을 만듭니다.
서명:
export declare function multiSelect(options: Record<string, string>): MultiSelectInput;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 옵션 | 레코드<문자열, 문자열> |
보고:
params.select()
일련의 값에서 선택 입력을 만듭니다.
서명:
export declare function select<T>(options: T[]): SelectInput<T>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 옵션 | 티[] |
보고:
입력 선택 <티>
params.select()
레이블과 값의 맵에서 선택 입력을 만듭니다.
서명:
export declare function select<T>(optionsWithLabels: Record<string, T>): SelectInput<T>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| optionsWithLabels | 레코드<문자열, T> |
보고:
입력 선택 <티>
매개변수.BUCKET_PICKER
사용자가 선택할 수 있는 프로젝트의 버킷 목록을 자동 생성합니다.
서명:
BUCKET_PICKER: ResourceInput
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옵션
매개변수의 프롬프트 동작을 사용자 정의하는 데 사용할 수 있는 구성 옵션입니다.
서명:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;