Class AttributeDataService

constructor

• new AttributeDataService(db, customFields): AttributeDataService

• Parameters

  • db: Db

  • customFields: CustomField[]

  Returns AttributeDataService

createAttribute

• createAttribute(attribute): Promise<{
      id: string;
  }>

• Create attribute into database

  Parameters

  • attribute: CreateAttributeDto

  Returns Promise<{
      id: string;
  }>

  Promise<{id: string}> id of created attribute record

deleteAttribute

• deleteAttribute(id): Promise<boolean>

• Delete attribute into database

  Parameters

  • id: string

  Returns Promise<boolean>

  id

doesAttributeExist

• doesAttributeExist(id): Promise<boolean>

• Check if attribute exist in database

  Parameters

  • id: string

    id of attribute to query

  Returns Promise<boolean>

  true if attribute exist, false if attribute not found

findAttributes

• findAttributes(query): Promise<WithId<AttributeEntity>[]>

• Find attributes that match the given query. This method does not support pagination.

  Parameters

  • query: Filter<AttributeEntity>

    query to filter attributes

  Returns Promise<WithId<AttributeEntity>[]>

  list of attributes

getAttribute

• getAttribute(id): Promise<null | AttributeEntity>

• Get attribute from database

  Parameters

  • id: string

  Returns Promise<null | AttributeEntity>

  Promise<Attribute | undefined> Attribute data if fetched successfully, or null if data not found by id

listPaginatedAttributes

• listPaginatedAttributes(opts): Promise<PaginatedFindResult<AttributeEntity>>

• List paginated attributes

  Parameters

  • opts: ParsedPaginatedListQuery

    paginated list query options

  Returns Promise<PaginatedFindResult<AttributeEntity>>

  paginated attribute list query result

normalizeAttributeResponse

• normalizeAttributeResponse(attribute): Promise<AttributeResponse>

• Normalize a single attribute response

  Parameters

  • attribute: Attribute

    attribute model

  Returns Promise<AttributeResponse>

normalizeAttributeResponses

• normalizeAttributeResponses(attributes): Promise<AttributeResponse[]>

• Normalize list of attribute responses

  Parameters

  • attributes: Attribute[]

    attribute models

  Returns Promise<AttributeResponse[]>

updateAttribute

• updateAttribute(id, attributeInfo): Promise<{
      id: string;
  }>

• Update attribute into database

  Parameters

  • id: string

  • attributeInfo: Partial<Omit<Attribute, "id">>

    data to update

  Returns Promise<{
      id: string;
  }>

  id

Static Readonly COLLECTION_ATTRIBUTE