npm promotes metadefinitions

    @acoustic-content-sdk/redux-feature-login
    TypeScript icon, indicating that this package has built-in type declarations

    9.0.10076 • Public • Published

    npm

    Feature store for authentication related aspects of Acoustic Content.

    API Documentation

    Home > @acoustic-content-sdk/redux-feature-login

    redux-feature-login package

    Feature store for authentication related aspects of Acoustic Content.

    Interfaces

    Interface Description
    LoggedInFeatureState
    LoginCredentials Credentials used to login
    NextLoginReduxState

    Variables

    Variable Description
    ACTION_CHECKED_LOGGED_IN
    ACTION_FEDERATED_LOGIN
    ACTION_LOGGED_IN
    ACTION_LOGGED_OUT
    ACTION_PASSWORD_LOGIN
    checkLoggedInAction Action to check if the system is logged in or not
    federatedLoginAction Action to execute a login
    loggedInAction Action to indicate that a successful login occurred
    loggedInFeature Exposes the feature module selector
    loggedInFeatureReducer
    loggedOutAction Action to indicate that a successful logout occurred
    nextLogin Returns an operator that emits once when a user logged in
    passwordLoginAction Action to execute a login
    selectLoggedInFeature Select the login feature
    VERSION Version and build number of the package

    Type Aliases

    Type Alias Description
    CheckLoggedInAction
    FederatedLoginAction
    LoggedInAction
    LoggedOutAction
    PasswordLoginAction

    Home > @acoustic-content-sdk/redux-feature-login > LoggedInFeatureState

    LoggedInFeatureState interface

    Signature:

    export interface LoggedInFeatureState 

    Properties

    Property Type Description
    loggedIn LoggedInState

    Home > @acoustic-content-sdk/redux-feature-login > LoginCredentials

    LoginCredentials interface

    Credentials used to login

    Signature:

    export interface LoginCredentials 

    Properties

    Property Type Description
    password string The WCH password
    username string The WCH username, typically an email or the string 'apikey'

    Home > @acoustic-content-sdk/redux-feature-login > NextLoginReduxState

    NextLoginReduxState interface

    Signature:

    export interface NextLoginReduxState extends LoggedInFeatureState 

    Home > @acoustic-content-sdk/redux-feature-login > ACTION_CHECKED_LOGGED_IN

    ACTION_CHECKED_LOGGED_IN variable

    Signature:

    ACTION_CHECKED_LOGGED_IN = "ACTION_CHECKED_LOGGED_IN"

    Home > @acoustic-content-sdk/redux-feature-login > ACTION_FEDERATED_LOGIN

    ACTION_FEDERATED_LOGIN variable

    Signature:

    ACTION_FEDERATED_LOGIN = "ACTION_FEDERATED_LOGIN"

    Home > @acoustic-content-sdk/redux-feature-login > ACTION_LOGGED_IN

    ACTION_LOGGED_IN variable

    Signature:

    ACTION_LOGGED_IN = "ACTION_LOGGED_IN"

    Home > @acoustic-content-sdk/redux-feature-login > ACTION_LOGGED_OUT

    ACTION_LOGGED_OUT variable

    Signature:

    ACTION_LOGGED_OUT = "ACTION_LOGGED_OUT"

    Home > @acoustic-content-sdk/redux-feature-login > ACTION_PASSWORD_LOGIN

    ACTION_PASSWORD_LOGIN variable

    Signature:

    ACTION_PASSWORD_LOGIN = "ACTION_PASSWORD_LOGIN"

    Home > @acoustic-content-sdk/redux-feature-login > checkLoggedInAction

    checkLoggedInAction variable

    Action to check if the system is logged in or not

    Signature:

    checkLoggedInAction: Generator<CheckLoggedInAction>

    Home > @acoustic-content-sdk/redux-feature-login > federatedLoginAction

    federatedLoginAction variable

    Action to execute a login

    Signature:

    federatedLoginAction: Generator<FederatedLoginAction>

    Home > @acoustic-content-sdk/redux-feature-login > loggedInAction

    loggedInAction variable

    Action to indicate that a successful login occurred

    Signature:

    loggedInAction: Generator<LoggedInAction>

    Home > @acoustic-content-sdk/redux-feature-login > loggedInFeature

    loggedInFeature variable

    Exposes the feature module selector

    Signature:

    loggedInFeature: import("@acoustic-content-sdk/redux-store").ReduxFeatureModule<boolean, LoggedInFeatureState, import("redux").AnyAction, import("redux").AnyAction, any>

    Home > @acoustic-content-sdk/redux-feature-login > loggedInFeatureReducer

    loggedInFeatureReducer variable

    Signature:

    loggedInFeatureReducer: {
        loggedIn: import("redux").Reducer<boolean, import("redux").AnyAction>;
    }

    Home > @acoustic-content-sdk/redux-feature-login > loggedOutAction

    loggedOutAction variable

    Action to indicate that a successful logout occurred

    Signature:

    loggedOutAction: Generator<LoggedOutAction>

    Home > @acoustic-content-sdk/redux-feature-login > nextLogin

    nextLogin variable

    Returns an operator that emits once when a user logged in

    Signature:

    nextLogin: OperatorFunction<NextLoginReduxState, boolean>

    Home > @acoustic-content-sdk/redux-feature-login > passwordLoginAction

    passwordLoginAction variable

    Action to execute a login

    Signature:

    passwordLoginAction: UnaryFunction<LoginCredentials, PasswordLoginAction>

    Home > @acoustic-content-sdk/redux-feature-login > selectLoggedInFeature

    selectLoggedInFeature variable

    Select the login feature

    Signature:

    selectLoggedInFeature: import("rxjs").UnaryFunction<Record<string, any>, boolean>

    Home > @acoustic-content-sdk/redux-feature-login > VERSION

    VERSION variable

    Version and build number of the package

    Signature:

    VERSION: {
        version: {
            major: string;
            minor: string;
            patch: string;
            branch: string;
        };
        build: Date;
    }

    Home > @acoustic-content-sdk/redux-feature-login > LoggedInFeatureState > loggedIn

    LoggedInFeatureState.loggedIn property

    Signature:

    [LOGIN_FEATURE]: LoggedInState;

    Home > @acoustic-content-sdk/redux-feature-login > LoginCredentials > password

    LoginCredentials.password property

    The WCH password

    Signature:

    password: string;

    Home > @acoustic-content-sdk/redux-feature-login > LoginCredentials > username

    LoginCredentials.username property

    The WCH username, typically an email or the string 'apikey'

    Signature:

    username: string;

    Install

    npm i @acoustic-content-sdk/redux-feature-login

    DownloadsWeekly Downloads

    7

    Version

    9.0.10076

    License

    MIT

    Unpacked Size

    270 kB

    Total Files

    66

    Last publish

    Collaborators

    • marcin-pasiewicz
    • nikodem.graczewski.acoustic
    • pawel.galias-ac
    • orenaksakal
    • marcin.konopka-ac