Interface IShogunCore

Interfaccia per la gestione dei plugin in ShogunCore

interface IShogunCore {
    config: ShogunCoreConfig;
    db: GunInstance;
    gun: IGunInstance<any>;
    provider?: Provider;
    rx: GunRxJS;
    signer?: Signer;
    storage: ShogunStorage;
    changeUsername(
        newUsername: string,
    ): Promise<
        {
            error?: string;
            newUsername?: string;
            oldUsername?: string;
            success: boolean;
        },
    >;
    emit(eventName: string | symbol, ...args: any[]): boolean;
    getAuthenticationMethod(type: AuthMethod): any;
    getCurrentUser(): null | { pub: string; user?: any };
    getPlugin<T>(name: string): undefined | T;
    getPluginsByCategory(category: PluginCategory): ShogunPlugin[];
    getRecentErrors(count?: number): ShogunError[];
    hasPlugin(name: string): boolean;
    isLoggedIn(): boolean;
    login(username: string, password: string): Promise<AuthResult>;
    logout(): void;
    off(eventName: string | symbol, listener: (...args: any[]) => void): any;
    on(eventName: string | symbol, listener: (...args: any[]) => void): any;
    once(eventName: string | symbol, listener: (...args: any[]) => void): any;
    register(plugin: ShogunPlugin): void;
    removeAllListeners(eventName?: string | symbol): any;
    signUp(
        username: string,
        password: string,
        passwordConfirmation?: string,
    ): Promise<SignUpResult>;
    unregister(pluginName: string): void;
}

Hierarchy (View Summary)

Implemented by

Properties

config db gun provider? rx signer? storage

Methods

changeUsername emit getAuthenticationMethod getCurrentUser getPlugin getPluginsByCategory getRecentErrors hasPlugin isLoggedIn login logout off on once register removeAllListeners signUp unregister

Properties

config

config: ShogunCoreConfig

db

db: GunInstance

gun

gun: IGunInstance<any>

Optionalprovider

provider?: Provider

rx

rx: GunRxJS

Optionalsigner

signer?: Signer

storage

storage: ShogunStorage

Methods

changeUsername

  • changeUsername(
        newUsername: string,
    ): Promise<
        {
            error?: string;
            newUsername?: string;
            oldUsername?: string;
            success: boolean;
        },
    >

    Parameters

    • newUsername: string

    Returns Promise<
        {
            error?: string;
            newUsername?: string;
            oldUsername?: string;
            success: boolean;
        },
    >

emit

  • emit(eventName: string | symbol, ...args: any[]): boolean

    Parameters

    • eventName: string | symbol
    • ...args: any[]

    Returns boolean

getAuthenticationMethod

getCurrentUser

  • getCurrentUser(): null | { pub: string; user?: any }

    Returns null | { pub: string; user?: any }

getPlugin

  • getPlugin<T>(name: string): undefined | T

    Recupera un plugin registrato per nome

    Type Parameters

    • T

      Tipo del plugin o dell'interfaccia pubblica del plugin

    Parameters

    • name: string

      Nome del plugin

    Returns undefined | T

    Il plugin richiesto o undefined se non trovato

getPluginsByCategory

getRecentErrors

hasPlugin

  • hasPlugin(name: string): boolean

    Verifica se un plugin è registrato

    Parameters

    • name: string

      Nome del plugin da verificare

    Returns boolean

    true se il plugin è registrato, false altrimenti

isLoggedIn

  • isLoggedIn(): boolean

    Returns boolean

login

  • login(username: string, password: string): Promise<AuthResult>

    Parameters

    • username: string
    • password: string

    Returns Promise<AuthResult>

logout

  • logout(): void

    Returns void

off

  • off(eventName: string | symbol, listener: (...args: any[]) => void): any

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void

    Returns any

on

  • on(eventName: string | symbol, listener: (...args: any[]) => void): any

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void

    Returns any

once

  • once(eventName: string | symbol, listener: (...args: any[]) => void): any

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void

    Returns any

register

removeAllListeners

  • removeAllListeners(eventName?: string | symbol): any

    Parameters

    • OptionaleventName: string | symbol

    Returns any

signUp

  • signUp(
        username: string,
        password: string,
        passwordConfirmation?: string,
    ): Promise<SignUpResult>

    Parameters

    • username: string
    • password: string
    • OptionalpasswordConfirmation: string

    Returns Promise<SignUpResult>

unregister

  • unregister(pluginName: string): void

    Cancella la registrazione di un plugin

    Parameters

    • pluginName: string

      Nome del plugin da cancellare

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods