Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Person

Index

References

Enumerations

Classes

Interfaces

Type aliases

Variables

Factory Functions

Field Resolver Functions

Mutation Resolver Functions

Other Functions

Query Resolver Functions

Object literals

References

CollegeEnum

Re-exports CollegeEnum

GenderEnum

Re-exports GenderEnum

MemberStatusEnum

Re-exports MemberStatusEnum

ModelTimestamps

Re-exports ModelTimestamps

PersonAttributes

Re-exports PersonAttributes

PersonCreationAttributes

Re-exports PersonCreationAttributes

PersonModelAttributes

Re-exports PersonModelAttributes

PersonUpdateAttributes

Re-exports PersonUpdateAttributes

RegistrationTypeEnum

Re-exports RegistrationTypeEnum

registrationTypeOf

Re-exports registrationTypeOf

statusOf

Re-exports statusOf

Type aliases

ApproveMembershipResolverArgs

ApproveMembershipResolverArgs: ApproveMembershipAttribute

The input arguments for the approveMembership mutation's resolver

ModelTimestamps

ModelTimestamps: { createdAt: Date; updatedAt: Date }

All the timestamps auto generated by sequelize

Type declaration

  • createdAt: Date
  • updatedAt: Date

PersonCreationAttributes

PersonCreationAttributes: Optional<Omit<PersonModelAttributes, "createdAt" | "updatedAt">, "id">

All the attributes needed to create an instance of the Person model

PersonModelAttributes

PersonModelAttributes: Omit<PersonAttributes, "status" | "registrationType"> & ModelTimestamps

All the attributes stored in the database

PersonUpdateAttributes

PersonUpdateAttributes: Partial<PersonModelAttributes> & Pick<PersonModelAttributes, "sid">

All the attributes needed to update an instance of the Person model

Variables

Const NON_MEMBER_STATUS

NON_MEMBER_STATUS: Unactivated = MemberStatusEnum.Unactivated

Factory Functions

Const PersonFactory

  • PersonFactory(sequelize: Sequelize): typeof Person

  • A helper function to create a store for the Person model

    Parameters

    • sequelize: Sequelize

      the database connection

    Returns typeof Person

    The created store

Field Resolver Functions

Const collegeResolver

Const majorResolver

  • majorResolver(__namedParameters: { major: string | Major }, _: null, __namedParameters: { dataSources: ResolverDatasource }): Major | undefined

Const registrationTypeResolver

Const statusResolver

Mutation Resolver Functions

Const approveMembershipResolver

Const importPeopleResolver

  • importPeopleResolver(_: ResolverParent, __namedParameters: { people: Optional<Pick<PersonModelAttributes, "id" | "sid" | "chineseName" | "englishName" | "gender" | "dateOfBirth" | "email" | "phone" | "college" | "major" | "dateOfEntry" | "expectedGraduationDate" | "memberSince" | "memberUntil">, "id">[] }, __namedParameters: { dataSources: ResolverDatasource; user: null | User }): Promise<PersonUpdateResponse[]>

  • The resolver for importPeople Mutation

    async

    Parameters

    • _: ResolverParent
    • __namedParameters: { people: Optional<Pick<PersonModelAttributes, "id" | "sid" | "chineseName" | "englishName" | "gender" | "dateOfBirth" | "email" | "phone" | "college" | "major" | "dateOfEntry" | "expectedGraduationDate" | "memberSince" | "memberUntil">, "id">[] }
      • people: Optional<Pick<PersonModelAttributes, "id" | "sid" | "chineseName" | "englishName" | "gender" | "dateOfBirth" | "email" | "phone" | "college" | "major" | "dateOfEntry" | "expectedGraduationDate" | "memberSince" | "memberUntil">, "id">[]
    • __namedParameters: { dataSources: ResolverDatasource; user: null | User }

    Returns Promise<PersonUpdateResponse[]>

    The update response

Const newPersonResolver

Const updatePersonResolver

Other Functions

Const registrationTypeOf

Const statusOf

Query Resolver Functions

Const membersResolver

Const peopleResolver

Const personResolver

Const registrationsResolver

Object literals

Const resolvers

resolvers: object

The resolvers associated with the Person model

Mutation

Mutation: object

approveMembership

approveMembership: ResolverFn<ApproveMembershipAttribute, PersonUpdateResponse> = approveMembershipResolver

see approveMembershipResolver

importPeople

importPeople: ResolverFn<{ people: PersonCreationAttributes[] }, PersonUpdateResponse[]> = importPeopleResolver

see importPeopleResolver

newPerson

newPerson: ResolverFn<Optional<Pick<PersonModelAttributes, "id" | "sid" | "chineseName" | "englishName" | "gender" | "dateOfBirth" | "email" | "phone" | "college" | "major" | "dateOfEntry" | "expectedGraduationDate" | "memberSince" | "memberUntil">, "id">, PersonUpdateResponse> = newPersonResolver

see newPersonResolver

updatePerson

updatePerson: ResolverFn<PersonUpdateAttributes, PersonUpdateResponse> = updatePersonResolver

see updatePersonResolver

Person

Person: object

college

college: ResolverFn<null, College> = collegeResolver

see collegeResolver

major

major: ResolverFn<null, undefined | Major> = majorResolver

see majorResolver

registrationType

registrationType: ResolverFn<null, null | New | Renewal> = registrationTypeResolver

see registrationTypeResolver

status

status: ResolverFn<null, MemberStatusEnum> = statusResolver

see statusResolver

Query

Query: object

members

members: ResolverFn<unknown, PersonModelAttributes[]> = membersResolver

see membersResolver

people

people: ResolverFn<unknown, PersonModelAttributes[]> = peopleResolver

see peopleResolver

person

person: ResolverFn<PersonResolverArgs, null | PersonModelAttributes> = personResolver

see personResolver

registrations

registrations: ResolverFn<unknown, PersonModelAttributes[]> = registrationsResolver

see registrationsResolver

Generated using TypeDoc