From 11cfec413c68e3de6e3a14c79f97304237166229 Mon Sep 17 00:00:00 2001 From: Jan Vlnas Date: Mon, 2 Jan 2023 15:01:53 +0100 Subject: [PATCH] chore(types): Mark public interfaces --- src/models/profile.ts | 6 ++++++ src/models/strategyOptions.ts | 9 +++++++++ src/strategy.ts | 3 +++ 3 files changed, 18 insertions(+) diff --git a/src/models/profile.ts b/src/models/profile.ts index 6ef3815..6d7026e 100644 --- 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 index 4864c98..28b0fd2 100644 --- 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 { 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 index dbb00a6..f6a3cff 100644 --- 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;