#Auth

#Обзор

Auth — это абстрактный класс для типов аутентификации пользователей. Он определяет интерфейсы, необходимые для выполнения аутентификации. Чтобы расширить или добавить новый тип аутентификации, вам нужно унаследовать класс Auth и реализовать его методы. Пример базовой реализации можно найти здесь: BaseAuth.

interface IAuth {
  user: Model;
  // Проверяет статус аутентификации и возвращает текущего пользователя.
  check(): Promise<Model>;
  signIn(): Promise<any>;
  signUp(): Promise<any>;
  signOut(): Promise<any>;
}

export abstract class Auth implements IAuth {
  abstract user: Model;
  abstract check(): Promise<Model>;
  // ...
}

class CustomAuth extends Auth {
  // check: аутентификация
  async check() {
    // ...
  }
}

#Свойства экземпляра

#user

Информация об аутентифицированном пользователе.

#Сигнатура

• abstract user: Model

#Методы класса

#constructor()

Конструктор, создаёт экземпляр Auth.

#Сигнатура

• constructor(config: AuthConfig)

#Тип

export type AuthConfig = {
  authenticator: Authenticator;
  options: {
    [key: string]: any;
  };
  ctx: Context;
};

#Подробности

#AuthConfig

#check()

Аутентификация пользователя. Возвращает информацию о пользователе. Это абстрактный метод, который должны реализовать все типы аутентификации.

#Сигнатура

• abstract check(): Promise<Model>

#signIn()

Вход пользователя.

#Сигнатура

• signIn(): Promise<any>

#signUp()

Регистрация пользователя.

#Сигнатура

• signUp(): Promise<any>

#signOut()

Выход пользователя.

#Сигнатура

• signOut(): Promise<any>