Merge pull request #3234 from svbutko/patch-1

Convert ShortLinkType to enum from interface
This commit is contained in:
Pablo Kebees
2020-03-12 10:47:26 +01:00
committed by GitHub

View File

@@ -371,28 +371,26 @@ export namespace FirebaseDynamicLinksTypes {
* const link = await firebase.dynamicLinks().buildShortLink({
* link: 'https://invertase.io',
* domainUriPrefix: 'https://xyz.page.link',
* }, firebase.dynamicLinks.ShortLinkType.UNGUESSABLE);
* }, FirebaseDynamicLinksTypes.ShortLinkType.UNGUESSABLE);
* ```
*/
export interface ShortLinkType {
export enum ShortLinkType {
/**
* Shorten the path to a string that is only as long as needed to be unique, with a minimum length
* of 4 characters. Use this if sensitive information would not be exposed if a short
* Dynamic Link URL were guessed.
*/
SHORT: 'SHORT';
SHORT = 'SHORT',
/**
* Shorten the path to an unguessable string. Such strings are created by base62-encoding randomly
* generated 96-bit numbers, and consist of 17 alphanumeric characters. Use unguessable strings
* to prevent your Dynamic DynamicLinks from being crawled, which can potentially expose sensitive information.
*/
UNGUESSABLE: 'UNGUESSABLE';
UNGUESSABLE = 'UNGUESSABLE',
/**
* By default, Firebase returns a standard formatted link.
*/
DEFAULT: 'DEFAULT';
DEFAULT = 'DEFAULT',
}
/**
@@ -430,9 +428,9 @@ export namespace FirebaseDynamicLinksTypes {
*/
export interface Statics {
/**
* Returns the {@link links.ShortLinkType} interface.
* Returns the {@link links.ShortLinkType} enum.
*/
ShortLinkType: ShortLinkType;
ShortLinkType: typeof ShortLinkType;
}
/**