Module daos/dumpsters

default

• default(__namedParameters: MyModels): { addOne: (dumpster: Omit<default, "dumpsterID" | "rating" | "visits">) => Promise<{ categories: string[]; cleanliness: number; dumpsterID: number; dumpsterType: string; emptyingSchedule: string; info: string; locked: boolean; name: string; position: default; positiveStoreViewOnDiving: null | boolean; rating: number; storeType: string; visits: number }>; getAll: (__namedParameters: PositionParams) => Promise<default[]>; getOne: (dumpsterID: number, visitSinceDate: string) => Promise<null | default>; getRevisions: (dumpsterID: number) => Promise<DumpsterRevision[]>; setActiveRevision: (dumpsterID: number, revisionID: number) => Promise<[number, DumpsterPositions[]]>; updateOne: (dumpster: Omit<default, "rating" | "visits">) => Promise<{ categories: string[]; cleanliness: number; dumpsterID: number; dumpsterType: string; emptyingSchedule: string; info: string; locked: boolean; name: string; position: default; positiveStoreViewOnDiving: null | boolean; rating: number; storeType: string; visits: number }> }

• Data Access Object for dumpsters

  Parameters

  • __namedParameters: MyModels

  Returns { addOne: (dumpster: Omit<default, "dumpsterID" | "rating" | "visits">) => Promise<{ categories: string[]; cleanliness: number; dumpsterID: number; dumpsterType: string; emptyingSchedule: string; info: string; locked: boolean; name: string; position: default; positiveStoreViewOnDiving: null | boolean; rating: number; storeType: string; visits: number }>; getAll: (__namedParameters: PositionParams) => Promise<default[]>; getOne: (dumpsterID: number, visitSinceDate: string) => Promise<null | default>; getRevisions: (dumpsterID: number) => Promise<DumpsterRevision[]>; setActiveRevision: (dumpsterID: number, revisionID: number) => Promise<[number, DumpsterPositions[]]>; updateOne: (dumpster: Omit<default, "rating" | "visits">) => Promise<{ categories: string[]; cleanliness: number; dumpsterID: number; dumpsterType: string; emptyingSchedule: string; info: string; locked: boolean; name: string; position: default; positiveStoreViewOnDiving: null | boolean; rating: number; storeType: string; visits: number }> }

  • addOne: (dumpster: Omit<default, "dumpsterID" | "rating" | "visits">) => Promise<{ categories: string[]; cleanliness: number; dumpsterID: number; dumpsterType: string; emptyingSchedule: string; info: string; locked: boolean; name: string; position: default; positiveStoreViewOnDiving: null | boolean; rating: number; storeType: string; visits: number }>

    • • (dumpster: Omit<default, "dumpsterID" | "rating" | "visits">): Promise<{ categories: string[]; cleanliness: number; dumpsterID: number; dumpsterType: string; emptyingSchedule: string; info: string; locked: boolean; name: string; position: default; positiveStoreViewOnDiving: null | boolean; rating: number; storeType: string; visits: number }>

      • Add a dumpster to the database table. When adding, the dumpster does not yet have an ID. A rather complex routine since a revision must be created, and the dumpster's current revision must be set to the one that was added.

        Parameters

        • dumpster: Omit<default, "dumpsterID" | "rating" | "visits">

        Returns Promise<{ categories: string[]; cleanliness: number; dumpsterID: number; dumpsterType: string; emptyingSchedule: string; info: string; locked: boolean; name: string; position: default; positiveStoreViewOnDiving: null | boolean; rating: number; storeType: string; visits: number }>

        The newly posted data, with an ID

  • getAll: (__namedParameters: PositionParams) => Promise<default[]>

    • • (__namedParameters: PositionParams): Promise<default[]>

      • Fetches all dumpsters in a given radius around a position (lat, long)

        Parameters

        • __namedParameters: PositionParams

        Returns Promise<default[]>

        The dumpsters that fit the query

  • getOne: (dumpsterID: number, visitSinceDate: string) => Promise<null | default>

    • • (dumpsterID: number, visitSinceDate: string): Promise<null | default>

      • Get one dumpster by ID TODO: Check if SQL injection is still possible after using sequelize.escape() (it should not, especially since the endpoint route requires an ID)

        Parameters

        • dumpsterID: number

        • visitSinceDate: string

        Returns Promise<null | default>

        null if not found, a dumpster if found

  • getRevisions: (dumpsterID: number) => Promise<DumpsterRevision[]>

    • • (dumpsterID: number): Promise<DumpsterRevision[]>

      • Get a dumpster's full revision history TODO pagination...

        Parameters

        • dumpsterID: number

        Returns Promise<DumpsterRevision[]>

        a list of revisions

  • setActiveRevision: (dumpsterID: number, revisionID: number) => Promise<[number, DumpsterPositions[]]>

    • • (dumpsterID: number, revisionID: number): Promise<[number, DumpsterPositions[]]>

      • Change a dumpster's active revision (used to revert to a previous edit in case of mischievous activity)

        Parameters

        • dumpsterID: number

          ID of the dumpster you'd like to update

        • revisionID: number

          Revision to revert to

        Returns Promise<[number, DumpsterPositions[]]>

  • updateOne: (dumpster: Omit<default, "rating" | "visits">) => Promise<{ categories: string[]; cleanliness: number; dumpsterID: number; dumpsterType: string; emptyingSchedule: string; info: string; locked: boolean; name: string; position: default; positiveStoreViewOnDiving: null | boolean; rating: number; storeType: string; visits: number }>

    • • (dumpster: Omit<default, "rating" | "visits">): Promise<{ categories: string[]; cleanliness: number; dumpsterID: number; dumpsterType: string; emptyingSchedule: string; info: string; locked: boolean; name: string; position: default; positiveStoreViewOnDiving: null | boolean; rating: number; storeType: string; visits: number }>

      • Much like its sibling addOne, this function must handle the revision system properly. It updates the current revision ID after the update has been completed – and the update is technically a creation, for that matter.

        Parameters

        • dumpster: Omit<default, "rating" | "visits">

        Returns Promise<{ categories: string[]; cleanliness: number; dumpsterID: number; dumpsterType: string; emptyingSchedule: string; info: string; locked: boolean; name: string; position: default; positiveStoreViewOnDiving: null | boolean; rating: number; storeType: string; visits: number }>

        The updated data