Function updatePatronById

  • Updates a patron by given ID.

    Patron is identified by their stringified ObjectID.

    Usage

    const patronId: string = "5f5e555d5a578b6";
    const patron: Partial<Patron> = {
    tier: "3"
    };

    const {
    acknowledged,
    matchedCount,
    modifiedCount,
    upsertedCount,
    upsertedId,
    } = await sdk.updatePatronById({ patronId, patron });

    Parameters

    • params: {
          patronId: string;
          patron: Partial<Omit<Patron, "_id">>;
      }
      • patronId: string

        ID of the patron to update.

      • patron: Partial<Omit<Patron, "_id">>

        Fields to update in the patron of given ID.

    Returns Promise<UpdateResult>

Generated using TypeDoc