Skip to content

Commit

Permalink
Update devsite docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dlarocque committed Oct 23, 2024
1 parent fcc03ad commit d693bfd
Show file tree
Hide file tree
Showing 8 changed files with 23 additions and 23 deletions.
8 changes: 4 additions & 4 deletions docs-devsite/analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -990,7 +990,7 @@ Whether a particular consent type has been granted or denied.
<b>Signature:</b>

```typescript
export declare type ConsentStatusString = 'granted' | 'denied';
export type ConsentStatusString = 'granted' | 'denied';
```

## Currency
Expand All @@ -1000,7 +1000,7 @@ Standard Google Analytics currency type.
<b>Signature:</b>

```typescript
export declare type Currency = string | number;
export type Currency = string | number;
```

## CustomEventName
Expand All @@ -1010,7 +1010,7 @@ Any custom event name string not in the standard list of recommended event names
<b>Signature:</b>

```typescript
export declare type CustomEventName<T> = T extends EventNameString ? never : T;
export type CustomEventName<T> = T extends EventNameString ? never : T;
```

## EventNameString
Expand All @@ -1020,5 +1020,5 @@ Type for standard Google Analytics event names. `logEvent` also accepts any cust
<b>Signature:</b>

```typescript
export declare type EventNameString = 'add_payment_info' | 'add_shipping_info' | 'add_to_cart' | 'add_to_wishlist' | 'begin_checkout' | 'checkout_progress' | 'exception' | 'generate_lead' | 'login' | 'page_view' | 'purchase' | 'refund' | 'remove_from_cart' | 'screen_view' | 'search' | 'select_content' | 'select_item' | 'select_promotion' | 'set_checkout_option' | 'share' | 'sign_up' | 'timing_complete' | 'view_cart' | 'view_item' | 'view_item_list' | 'view_promotion' | 'view_search_results';
export type EventNameString = 'add_payment_info' | 'add_shipping_info' | 'add_to_cart' | 'add_to_wishlist' | 'begin_checkout' | 'checkout_progress' | 'exception' | 'generate_lead' | 'login' | 'page_view' | 'purchase' | 'refund' | 'remove_from_cart' | 'screen_view' | 'search' | 'select_content' | 'select_item' | 'select_promotion' | 'set_checkout_option' | 'share' | 'sign_up' | 'timing_complete' | 'view_cart' | 'view_item' | 'view_item_list' | 'view_promotion' | 'view_search_results';
```
2 changes: 1 addition & 1 deletion docs-devsite/app-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,5 +197,5 @@ A listener that is called whenever the App Check token changes.
<b>Signature:</b>

```typescript
export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;
export type AppCheckTokenListener = (token: AppCheckTokenResult) => void;
```
8 changes: 4 additions & 4 deletions docs-devsite/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -2114,7 +2114,7 @@ Map of OAuth Custom Parameters.
<b>Signature:</b>

```typescript
export declare type CustomParameters = Record<string, string>;
export type CustomParameters = Record<string, string>;
```

## NextOrObserver
Expand All @@ -2124,7 +2124,7 @@ Type definition for an event callback.
<b>Signature:</b>

```typescript
export declare type NextOrObserver<T> = NextFn<T | null> | Observer<T | null>;
export type NextOrObserver<T> = NextFn<T | null> | Observer<T | null>;
```

## PhoneInfoOptions
Expand All @@ -2136,7 +2136,7 @@ The information that's required depends on whether you are doing single-factor s
<b>Signature:</b>

```typescript
export declare type PhoneInfoOptions = PhoneSingleFactorInfoOptions | PhoneMultiFactorEnrollInfoOptions | PhoneMultiFactorSignInInfoOptions;
export type PhoneInfoOptions = PhoneSingleFactorInfoOptions | PhoneMultiFactorEnrollInfoOptions | PhoneMultiFactorSignInInfoOptions;
```

## UserProfile
Expand All @@ -2146,5 +2146,5 @@ User profile used in [AdditionalUserInfo](./auth.additionaluserinfo.md#additiona
<b>Signature:</b>

```typescript
export declare type UserProfile = Record<string, unknown>;
export type UserProfile = Record<string, unknown>;
```
6 changes: 3 additions & 3 deletions docs-devsite/functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ Possible values: - 'cancelled': The operation was cancelled (typically by the ca
<b>Signature:</b>

```typescript
export declare type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;
export type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;
```

## FunctionsErrorCodeCore
Expand All @@ -157,7 +157,7 @@ Functions error code string appended after "functions/" product prefix. See [Fun
<b>Signature:</b>

```typescript
export declare type FunctionsErrorCodeCore = 'ok' | 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';
export type FunctionsErrorCodeCore = 'ok' | 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';
```

## HttpsCallable
Expand All @@ -167,5 +167,5 @@ A reference to a "callable" HTTP trigger in Google Cloud Functions.
<b>Signature:</b>

```typescript
export declare type HttpsCallable<RequestData = unknown, ResponseData = unknown> = (data?: RequestData | null) => Promise<HttpsCallableResult<ResponseData>>;
export type HttpsCallable<RequestData = unknown, ResponseData = unknown> = (data?: RequestData | null) => Promise<HttpsCallableResult<ResponseData>>;
```
4 changes: 2 additions & 2 deletions docs-devsite/installations.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ An user defined callback function that gets called when Installations ID changes
<b>Signature:</b>

```typescript
export declare type IdChangeCallbackFn = (installationId: string) => void;
export type IdChangeCallbackFn = (installationId: string) => void;
```

## IdChangeUnsubscribeFn
Expand All @@ -162,5 +162,5 @@ Unsubscribe a callback function previously added via [IdChangeCallbackFn](./inst
<b>Signature:</b>

```typescript
export declare type IdChangeUnsubscribeFn = () => void;
export type IdChangeUnsubscribeFn = () => void;
```
6 changes: 3 additions & 3 deletions docs-devsite/remote-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ Summarizes the outcome of the last attempt to fetch config from the Firebase Rem
<b>Signature:</b>

```typescript
export declare type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle';
export type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle';
```

## LogLevel
Expand All @@ -335,7 +335,7 @@ Defines levels of Remote Config logging.
<b>Signature:</b>

```typescript
export declare type LogLevel = 'debug' | 'error' | 'silent';
export type LogLevel = 'debug' | 'error' | 'silent';
```

## ValueSource
Expand All @@ -347,5 +347,5 @@ Indicates the source of a value.
<b>Signature:</b>

```typescript
export declare type ValueSource = 'static' | 'default' | 'remote';
export type ValueSource = 'static' | 'default' | 'remote';
```
6 changes: 3 additions & 3 deletions docs-devsite/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -493,7 +493,7 @@ An enumeration of the possible string formats for upload.
<b>Signature:</b>

```typescript
export declare type StringFormat = (typeof StringFormat)[keyof typeof StringFormat];
export type StringFormat = (typeof StringFormat)[keyof typeof StringFormat];
```

## TaskEvent
Expand All @@ -503,7 +503,7 @@ An event that is triggered on a task.
<b>Signature:</b>

```typescript
export declare type TaskEvent = 'state_changed';
export type TaskEvent = 'state_changed';
```

## TaskState
Expand All @@ -513,7 +513,7 @@ Represents the current state of a running upload.
<b>Signature:</b>

```typescript
export declare type TaskState = 'running' | 'paused' | 'success' | 'canceled' | 'error';
export type TaskState = 'running' | 'paused' | 'success' | 'canceled' | 'error';
```

## StorageErrorCode
Expand Down
6 changes: 3 additions & 3 deletions docs-devsite/vertexai.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ Content part - includes text, image/video, or function call/response part types.
<b>Signature:</b>

```typescript
export declare type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart;
export type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart;
```

## Role
Expand All @@ -194,7 +194,7 @@ Role is the producer of the content.
<b>Signature:</b>

```typescript
export declare type Role = (typeof POSSIBLE_ROLES)[number];
export type Role = (typeof POSSIBLE_ROLES)[number];
```

## Tool
Expand All @@ -214,7 +214,7 @@ A type that includes all specific Schema types.
<b>Signature:</b>

```typescript
export declare type TypedSchema = IntegerSchema | NumberSchema | StringSchema | BooleanSchema | ObjectSchema | ArraySchema;
export type TypedSchema = IntegerSchema | NumberSchema | StringSchema | BooleanSchema | ObjectSchema | ArraySchema;
```

## BlockReason
Expand Down

0 comments on commit d693bfd

Please sign in to comment.