Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @nymphjs/tilmeld

Index

Classes

Interfaces

Type aliases

Properties

Type aliases

AccessControlData

AccessControlData: { acFull?: ((User & UserData) | (Group & GroupData))[]; acGroup?: number; acOther?: number; acRead?: ((User & UserData) | (Group & GroupData))[]; acUser?: number; acWrite?: ((User & UserData) | (Group & GroupData))[]; group?: Group & GroupData; user?: User & UserData }

Type declaration

EventType

EventType: "beforeRegister" | "afterRegister" | "beforeLogin" | "afterLogin" | "beforeLogout" | "afterLogout"

GroupData

GroupData: { abilities?: string[]; avatar?: string; defaultPrimary?: boolean; defaultSecondary?: boolean; email?: string; enabled?: boolean; groupname?: string; name?: string; parent?: Group & GroupData; phone?: string; unverifiedSecondary?: boolean; user?: (User & UserData) | null }

Type declaration

  • Optional abilities?: string[]

    The abilities granted to the group.

  • Optional avatar?: string

    The group's avatar URL. (Use getAvatar() to support Gravatar.)

  • Optional defaultPrimary?: boolean

    Whether this group is the default primary group for new users.

  • Optional defaultSecondary?: boolean

    Whether this group is a default secondary group for new users.

  • Optional email?: string

    The group's email address.

  • Optional enabled?: boolean

    Whether the group can be used.

  • Optional groupname?: string

    The group's groupname.

  • Optional name?: string

    The group's name.

  • Optional parent?: Group & GroupData

    The group's parent.

  • Optional phone?: string

    The group's telephone number.

  • Optional unverifiedSecondary?: boolean

    Whether this group is a default secondary group for unverified users.

  • Optional user?: (User & UserData) | null

    If generatePrimary is on, this will be the user who generated this group.

TilmeldAfterLoginCallback

TilmeldAfterLoginCallback: (user: User & UserData) => void

Type declaration

    • This is run before the transaction is committed, and you can perform additional functions on the transaction, which is available in user.$nymph.

      Parameters

      Returns void

TilmeldAfterLogoutCallback

TilmeldAfterLogoutCallback: (user: User & UserData) => void

Type declaration

TilmeldAfterRegisterCallback

TilmeldAfterRegisterCallback: (user: User & UserData, result: { loggedin: boolean; message: string }) => Promise<void> | void

Type declaration

    • (user: User & UserData, result: { loggedin: boolean; message: string }): Promise<void> | void

    • Parameters

      • user: User & UserData
      • result: { loggedin: boolean; message: string }
        • loggedin: boolean
        • message: string

      Returns Promise<void> | void

TilmeldBeforeLoginCallback

TilmeldBeforeLoginCallback: (user: User & UserData, data: { additionalData?: {}; password: string; username: string }) => void

Type declaration

    • (user: User & UserData, data: { additionalData?: {}; password: string; username: string }): void

    • These are run after the authentication checks, but before the login action.

      Parameters

      • user: User & UserData
      • data: { additionalData?: {}; password: string; username: string }
        • Optional additionalData?: {}
          • [k: string]: any
        • password: string
        • username: string

      Returns void

TilmeldBeforeLogoutCallback

TilmeldBeforeLogoutCallback: (user: User & UserData) => void

Type declaration

TilmeldBeforeRegisterCallback

TilmeldBeforeRegisterCallback: (user: User & UserData, data: { additionalData?: {}; password: string }) => Promise<void> | void

Type declaration

    • (user: User & UserData, data: { additionalData?: {}; password: string }): Promise<void> | void

    • Theses are run before the user data checks, so the only checks before are whether registration is allowed and whether the user is already registered.

      Parameters

      • user: User & UserData
      • data: { additionalData?: {}; password: string }
        • Optional additionalData?: {}
          • [k: string]: any
        • password: string

      Returns Promise<void> | void

UserData

UserData: { abilities?: string[]; avatar?: string; cancelEmailAddress?: string; cancelEmailSecret?: string; email?: string; emailChangeDate?: number; enabled?: boolean; group?: Group & GroupData; groups?: (Group & GroupData)[]; inheritAbilities?: boolean; name?: string; nameFirst?: string; nameLast?: string; nameMiddle?: string; newEmailAddress?: string; newEmailSecret?: string; password?: string; passwordTemp?: string; phone?: string; recoverSecret?: string; recoverSecretDate?: number; salt?: string; secret?: string; username?: string }

Type declaration

  • Optional abilities?: string[]

    The abilities granted to the user.

  • Optional avatar?: string

    The user's avatar URL. (Use $getAvatar() to support Gravatar.)

  • Optional cancelEmailAddress?: string

    The old email address.

  • Optional cancelEmailSecret?: string

    An email change cancellation secret.

  • Optional email?: string

    The user's email address.

  • Optional emailChangeDate?: number

    The timestamp of when the email address was last changed.

  • Optional enabled?: boolean

    Whether the user can log in.

  • Optional group?: Group & GroupData

    The user's primary group.

  • Optional groups?: (Group & GroupData)[]

    The user's secondary groups.

  • Optional inheritAbilities?: boolean

    Whether the user should inherit the abilities of his groups.

  • Optional name?: string

    The user's full name. This is generated from the first, middle, and last names.

  • Optional nameFirst?: string

    The user's first name.

  • Optional nameLast?: string

    The user's last name.

  • Optional nameMiddle?: string

    The user's middle name.

  • Optional newEmailAddress?: string

    The new email address.

  • Optional newEmailSecret?: string

    An email change proceed secret.

  • Optional password?: string

    The password or password hash.

  • Optional passwordTemp?: string

    Temporary storage for passwords. This will be hashed before going into the database.

  • Optional phone?: string

    The user's telephone number.

  • Optional recoverSecret?: string

    A recovery secret.

  • Optional recoverSecretDate?: number

    The timestamp of when the recovery secret was issued.

  • Optional salt?: string

    The password hash salt.

  • Optional secret?: string

    A verification secret.

  • Optional username?: string

    The user's username.

Properties

ConfigDefaults

ConfigDefaults: Config

tilmeldJoiProps

tilmeldJoiProps: { acFull: ArraySchema; acGroup: NumberSchema; acOther: NumberSchema; acRead: ArraySchema; acUser: NumberSchema; acWrite: ArraySchema; group: ObjectSchema<any>; user: ObjectSchema<any> }

Type declaration

  • acFull: ArraySchema
  • acGroup: NumberSchema
  • acOther: NumberSchema
  • acRead: ArraySchema
  • acUser: NumberSchema
  • acWrite: ArraySchema
  • group: ObjectSchema<any>
  • user: ObjectSchema<any>

Generated using TypeDoc