chore(types): Mark public interfaces

superfaceai · Jan 2, 2023 · 11cfec4 · 11cfec4
1 parent ef1965d
commit 11cfec4
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/src/models/profile.ts b/src/models/profile.ts
@@ -1,10 +1,16 @@
 import * as passport from 'passport';
 
+/**
+ * @public
+ */
 export interface Profile extends passport.Profile {
   username: string;
   profileUrl: string;
 }
 
+/**
+ * @public
+ */
 export interface ProfileWithMetaData extends Profile {
   _raw: string | Buffer | undefined;
   _json: unknown;

diff --git a/src/models/strategyOptions.ts b/src/models/strategyOptions.ts
@@ -12,12 +12,18 @@ interface TwitterStrategyOptionsBase {
   tokenURL?: string | undefined;
 }
 
+/**
+ * @public
+ */
 export interface StrategyOptions
   extends TwitterStrategyOptionsBase,
     Omit<PassportOAuth2StrategyOptions, 'authorizationURL' | 'tokenURL'> {
   passReqToCallback?: false | undefined;
 }
 
+/**
+ * @public
+ */
 export interface StrategyOptionWithRequest
   extends TwitterStrategyOptionsBase,
     Omit<
@@ -27,6 +33,9 @@ export interface StrategyOptionWithRequest
   passReqToCallback: true;
 }
 
+/**
+ * @public
+ */
 export interface AuthenticateOptions {
   scope?: string[] | string | undefined;
   state?: unknown | undefined;

diff --git a/src/strategy.ts b/src/strategy.ts
@@ -6,6 +6,9 @@ import { StrategyOptions } from './models/strategyOptions';
 import { TwitterError } from './models/twitterError';
 import { TwitterUserInfoResponse } from './models/twitterUserInfo';
 
+/**
+ * @public
+ */
 export class Strategy extends OAuth2Strategy {
   _userProfileURL: string;