Function updateFeaturedById

  • Updates a featured object by given ID.

    Featured object is identified by its stringified ObjectID.

    Usage

    const featuredId: string = "5f5e555d5a578b6";
    const featured: Partial<Featured> = {
    description: "I actually won this run",
    };

    const {
    acknowledged,
    matchedCount,
    modifiedCount,
    upsertedCount,
    upsertedId,
    } = await sdk.updateFeaturedById({ featuredId, featured });

    Parameters

    • params: {
          featuredId: string;
          featured: Partial<Omit<Featured, "_id">>;
      }
      • featuredId: string

        ID of the featured object to update.

      • featured: Partial<Omit<Featured, "_id">>

        Fields to update in the featured object of given ID.

    Returns Promise<UpdateResult>

Generated using TypeDoc