Skip to content

Fixing broken @link tags for https docs #1115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 10, 2022
Merged

Fixing broken @link tags for https docs #1115

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f782a58
Fixing broken @link tags for https docs
joehan May 10, 2022
55f46d8
Merge branch 'master' into jh-https-docs-2
joehan May 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/v2/providers/https.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export interface HttpsOptions extends Omit<GlobalOptions, 'region'> {
/** If true, allows CORS on requests to this function.
* If this is a `string` or `RegExp`, allows requests from domains that match the provided value.
* If this is an `Array`, allows requests from domains matching at least one entry of the array.
* Defaults to true for {@link CallableFunction}s and false otherwise.
* Defaults to true for {@link https.CallableFunction} and false otherwise.
*/
cors?: string | boolean | RegExp | Array<string | RegExp>;
}
Expand Down Expand Up @@ -79,7 +79,7 @@ export interface CallableFunction<T, Return> extends HttpsFunction {
/**
* Handles HTTPS requests.
* @param opts - Options to set on this function
* @param handler - A function that takes a {@link Request} and response object, same signature as an Express app.
* @param handler - A function that takes a {@link https.Request} and response object, same signature as an Express app.
* @returns A function that you can export and deploy.
*/
export function onRequest(
Expand All @@ -91,7 +91,7 @@ export function onRequest(
): HttpsFunction;
/**
* Handles HTTPS requests.
* @param handler - A function that takes a {@link Request} and response object, same signature as an Express app.
* @param handler - A function that takes a {@link https.Request} and response object, same signature as an Express app.
* @returns A function that you can export and deploy.
*/
export function onRequest(
Expand Down Expand Up @@ -194,7 +194,7 @@ export function onRequest(
/**
* Declares a callable method for clients to call using a Firebase SDK.
* @param opts - Options to set on this function.
* @param handler - A function that takes a {@link CallableRequest}.
* @param handler - A function that takes a {@link https.CallableRequest}.
* @returns A function that you can export and deploy.
*/
export function onCall<T = any, Return = any | Promise<any>>(
Expand All @@ -203,7 +203,7 @@ export function onCall<T = any, Return = any | Promise<any>>(
): CallableFunction<T, Return>;
/**
* Declares a callable method for clients to call using a Firebase SDK.
* @param handler - A function that takes a {@link CallableRequest}.
* @param handler - A function that takes a {@link https.CallableRequest}.
* @returns A function that you can export and deploy.
*/
export function onCall<T = any, Return = any | Promise<any>>(
Expand Down