espe/backend
0
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions

[doc] member-service: docblocks

Browse source
This commit is contained in:
roydfalk 2024-05-20 09:52:09 +02:00
parent b4db263685
commit 8d0cbca75d
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
source/services/member.ts
View file

@ -111,6 +111,7 @@ namespace _espe.service.member
/** /**
* ermittelt den Anmelde-Name des Mitglieds
*/ */
export function name_login( export function name_login(
object : _espe.type.member_object object : _espe.type.member_object
@ -142,6 +143,7 @@ namespace _espe.service.member
/** /**
* ermittelt den Anzeige-Name des Mitglieds
*/ */
export function name_display( export function name_display(
object : _espe.type.member_object object : _espe.type.member_object
@ -152,6 +154,7 @@ namespace _espe.service.member
/** /**
* ermittelt die verschleierte E-Mail-Adresse des Mitglieds
*/ */
export function email_address_veiled( export function email_address_veiled(
object : _espe.type.member_object object : _espe.type.member_object
@ -169,6 +172,7 @@ namespace _espe.service.member
/** /**
* ermittelt die namentliche E-Mail-Adresse des Mitglieds
*/ */
export function email_address_nominal( export function email_address_nominal(
object : _espe.type.member_object object : _espe.type.member_object
@ -185,6 +189,7 @@ namespace _espe.service.member
/** /**
* ermittelt die allgemein zu verwendende E-Mail-Adresse des Mitglieds
*/ */
export function email_address( export function email_address(
object : _espe.type.member_object object : _espe.type.member_object
@ -203,6 +208,7 @@ namespace _espe.service.member
/** /**
* gibt die vollständigen Daten aller Mitglieder aus
*/ */
async function dump( async function dump(
) : Promise< ) : Promise<
@ -219,6 +225,7 @@ namespace _espe.service.member
/** /**
* gibt eine Auflistung aller Mitgliedr aus
*/ */
export async function list( export async function list(
search_term : (null | string) search_term : (null | string)
@ -241,6 +248,7 @@ namespace _espe.service.member
/** /**
* gibt die Angaben eines bestimmten Mitglieds aus
*/ */
export function get( export function get(
id : _espe.type.member_id id : _espe.type.member_id
@ -251,6 +259,7 @@ namespace _espe.service.member
/** /**
* legt ein Mitglied an
*/ */
export async function project( export async function project(
data : { data : {
@ -281,6 +290,7 @@ namespace _espe.service.member
/** /**
* sendet an ein Mitglied eine E-Mail mit Aufforderung zur Registrierung
*/ */
export async function summon( export async function summon(
member_id : _espe.type.member_id, member_id : _espe.type.member_id,
@ -314,6 +324,7 @@ namespace _espe.service.member
/** /**
* gibt Daten über ein Mitglied aus, die relevant für die Registrierung sind
*/ */
export async function info( export async function info(
member_id : _espe.type.member_id member_id : _espe.type.member_id
@ -348,6 +359,8 @@ namespace _espe.service.member
/** /**
* führt die Registrierung für ein Mitglied durch
*
* @todo customize notifiation email (conf values) * @todo customize notifiation email (conf values)
*/ */
export async function register( export async function register(
@ -430,6 +443,7 @@ namespace _espe.service.member
/** /**
* ändert bestimmte Daten des Mitglied
*/ */
export async function modify( export async function modify(
member_id : _espe.type.member_id, member_id : _espe.type.member_id,