Function endSeasonById

  • Ends an active season by the given ID (if it exists). The season must already be created AND active AND NOT finished.

    Season is identified by its stringified ObjectID.

    Usage

    const seasonId: string = "9e9f99daa45c7";
    const {
    acknowledged,
    matchedCount,
    modifiedCount,
    upsertedCount,
    upsertedId,
    } = await sdk.endSeasonById({ seasonId });

    Parameters

    • params: {
          seasonId: string;
      }
      • seasonId: string

        ID of the season to be ended.

    Returns Promise<UpdateResult>

Generated using TypeDoc