update method name

Author: zhiyuanliang-ms

src/filter/recurrence/evaluator.ts

@@ -16,7 +16,7 @@ type RecurrenceState = {
  * @returns True if the given time is within any recurring time window; otherwise, false
  */
 export function matchRecurrence(time: Date, recurrenceSpec: RecurrenceSpec): boolean {
-    const recurrenceState = FindPreviousRecurrence(time, recurrenceSpec);
+    const recurrenceState = findPreviousRecurrence(time, recurrenceSpec);
     if (recurrenceState) {
         return time.getTime() < recurrenceState.previousOccurrence.getTime() + recurrenceSpec.duration;
     }
@@ -29,16 +29,16 @@ export function matchRecurrence(time: Date, recurrenceSpec: RecurrenceSpec): boo
  * @param recurrenceSpec The recurrence specification
  * @returns The recurrence state if any previous occurrence is found; otherwise, undefined
  */
-function FindPreviousRecurrence(time: Date, recurrenceSpec: RecurrenceSpec): RecurrenceState | undefined {
+function findPreviousRecurrence(time: Date, recurrenceSpec: RecurrenceSpec): RecurrenceState | undefined {
     if (time < recurrenceSpec.startTime) {
         return undefined;
     }
     let result: RecurrenceState;
     const pattern = recurrenceSpec.pattern;
     if (pattern.type === RecurrencePatternType.Daily) {
-        result = FindPreviousDailyRecurrence(time, recurrenceSpec);
+        result = findPreviousDailyRecurrence(time, recurrenceSpec);
     } else if (pattern.type === RecurrencePatternType.Weekly) {
-        result = FindPreviousWeeklyRecurrence(time, recurrenceSpec);
+        result = findPreviousWeeklyRecurrence(time, recurrenceSpec);
     } else {
         throw new Error("Unsupported recurrence pattern type.");
     }
@@ -57,7 +57,7 @@ function FindPreviousRecurrence(time: Date, recurrenceSpec: RecurrenceSpec): Rec
     return result;
 }
 
-function FindPreviousDailyRecurrence(time: Date, recurrenceSpec: RecurrenceSpec): RecurrenceState {
+function findPreviousDailyRecurrence(time: Date, recurrenceSpec: RecurrenceSpec): RecurrenceState {
     const startTime = recurrenceSpec.startTime;
     const timeGap = time.getTime() - startTime.getTime();
     const pattern = recurrenceSpec.pattern;
@@ -68,7 +68,7 @@ function FindPreviousDailyRecurrence(time: Date, recurrenceSpec: RecurrenceSpec)
     };
 }
 
-function FindPreviousWeeklyRecurrence(time: Date, recurrenceSpec: RecurrenceSpec): RecurrenceState {
+function findPreviousWeeklyRecurrence(time: Date, recurrenceSpec: RecurrenceSpec): RecurrenceState {
     /*
      * Algorithm:
      * 1. first find day 0 (d0), it's the day representing the start day on the week of `Start`.

src/filter/recurrence/utils.ts

@@ -28,11 +28,11 @@ export function sortDaysOfWeek(daysOfWeek: DayOfWeek[], firstDayOfWeek: DayOfWee
 /**
  * Gets the day of week of a given date based on the timezone offset.
  * @param date A UTC date
- * @param timezoneOffset The timezone offset in milliseconds
+ * @param timezoneOffsetInMs The timezone offset in milliseconds
  * @returns The day of week (0 for Sunday, 1 for Monday, ..., 6 for Saturday)
  */
-export function getDayOfWeek(date: Date, timezoneOffset: number): number {
-    const alignedDate = new Date(date.getTime() + timezoneOffset);
+export function getDayOfWeek(date: Date, timezoneOffsetInMs: number): number {
+    const alignedDate = new Date(date.getTime() + timezoneOffsetInMs);
     return alignedDate.getUTCDay();
 }
 

src/filter/recurrence/validator.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { RecurrenceParameter } from "../timeWindowFilter.js";
+import { RecurrenceParameters } from "../timeWindowFilter.js";
 import { VALUE_OUT_OF_RANGE_ERROR_MESSAGE, UNRECOGNIZABLE_VALUE_ERROR_MESSAGE, REQUIRED_PARAMETER_MISSING_ERROR_MESSAGE, buildInvalidParameterErrorMessage } from "../utils.js";
 import { DayOfWeek, RecurrenceSpec, RecurrencePattern, RecurrenceRange, RecurrencePatternType, RecurrenceRangeType, DAYS_PER_WEEK, ONE_DAY_IN_MILLISECONDS } from "./model.js";
 import { calculateWeeklyDayOffset, sortDaysOfWeek, getDayOfWeek } from "./utils.js";
@@ -19,14 +19,14 @@ export const END_DATE = "Recurrence.Range.EndDate";
 export const NUMBER_OF_OCCURRENCES = "Recurrence.Range.NumberOfOccurrences";
 
 /**
- * Parses @see RecurrenceParameter into a @see RecurrenceSpec object. If the parameter is invalid, an error will be thrown.
+ * Parses @see RecurrenceParameters into a @see RecurrenceSpec object. If the parameter is invalid, an error will be thrown.
  * @param startTime The start time of the base time window
  * @param day2 The end time of the base time window
- * @param recurrenceParameter The @see RecurrenceParameter to parse
+ * @param recurrenceParameters The @see RecurrenceParameters to parse
  * @param TimeZoneOffset The time zone offset in milliseconds, by default 0
  * @returns A @see RecurrenceSpec object
  */
-export function parseRecurrenceParameter(startTime: Date | undefined, endTime: Date | undefined, recurrenceParameter: RecurrenceParameter, TimeZoneOffset: number = 0): RecurrenceSpec {
+export function parseRecurrenceParameter(startTime: Date | undefined, endTime: Date | undefined, recurrenceParameters: RecurrenceParameters, TimeZoneOffset: number = 0): RecurrenceSpec {
     if (startTime === undefined) {
         throw new Error(buildInvalidParameterErrorMessage("Start", REQUIRED_PARAMETER_MISSING_ERROR_MESSAGE));
     }
@@ -44,14 +44,14 @@ export function parseRecurrenceParameter(startTime: Date | undefined, endTime: D
     return {
         startTime: startTime,
         duration: timeWindowDuration,
-        pattern: parseRecurrencePattern(startTime, endTime, recurrenceParameter, TimeZoneOffset),
-        range: parseRecurrenceRange(startTime, recurrenceParameter),
+        pattern: parseRecurrencePattern(startTime, endTime, recurrenceParameters, TimeZoneOffset),
+        range: parseRecurrenceRange(startTime, recurrenceParameters),
         timezoneOffset: TimeZoneOffset
     };
 }
 
-function parseRecurrencePattern(startTime: Date, endTime: Date, recurrenceParameter: RecurrenceParameter, timeZoneOffset: number): RecurrencePattern {
-    const rawPattern = recurrenceParameter.Pattern;
+function parseRecurrencePattern(startTime: Date, endTime: Date, recurrenceParameters: RecurrenceParameters, timeZoneOffset: number): RecurrencePattern {
+    const rawPattern = recurrenceParameters.Pattern;
     if (rawPattern === undefined) {
         throw new Error(buildInvalidParameterErrorMessage(PATTERN, REQUIRED_PARAMETER_MISSING_ERROR_MESSAGE));
     }
@@ -105,7 +105,7 @@ function parseRecurrencePattern(startTime: Date, endTime: Date, recurrenceParame
             throw new Error(buildInvalidParameterErrorMessage(DAYS_OF_WEEK, UNRECOGNIZABLE_VALUE_ERROR_MESSAGE));
         }
         if (timeWindowDuration > interval * DAYS_PER_WEEK * ONE_DAY_IN_MILLISECONDS ||
-            !IsDurationCompliantWithDaysOfWeek(timeWindowDuration, interval, daysOfWeek, firstDayOfWeek)) {
+            !isDurationCompliantWithDaysOfWeek(timeWindowDuration, interval, daysOfWeek, firstDayOfWeek)) {
             throw new Error(buildInvalidParameterErrorMessage("End", TIME_WINDOW_DURATION_OUT_OF_RANGE_ERROR_MESSAGE));
         }
         parsedPattern.daysOfWeek = daysOfWeek;
@@ -119,8 +119,8 @@ function parseRecurrencePattern(startTime: Date, endTime: Date, recurrenceParame
     return parsedPattern;
 }
 
-function parseRecurrenceRange(startTime: Date, recurrenceParameter: RecurrenceParameter): RecurrenceRange {
-    const rawRange = recurrenceParameter.Range;
+function parseRecurrenceRange(startTime: Date, recurrenceParameters: RecurrenceParameters): RecurrenceRange {
+    const rawRange = recurrenceParameters.Range;
     if (rawRange === undefined) {
         throw new Error(buildInvalidParameterErrorMessage(RANGE, REQUIRED_PARAMETER_MISSING_ERROR_MESSAGE));
     }
@@ -162,7 +162,7 @@ function parseRecurrenceRange(startTime: Date, recurrenceParameter: RecurrencePa
     return parsedRange;
 }
 
-function IsDurationCompliantWithDaysOfWeek(duration: number, interval: number, daysOfWeek: DayOfWeek[], firstDayOfWeek: DayOfWeek): boolean {
+function isDurationCompliantWithDaysOfWeek(duration: number, interval: number, daysOfWeek: DayOfWeek[], firstDayOfWeek: DayOfWeek): boolean {
     if (daysOfWeek.length === 1) {
         return true;
     }

src/filter/timeWindowFilter.ts

@@ -15,10 +15,10 @@ type TimeWindowFilterEvaluationContext = {
 type TimeWindowParameters = {
     Start?: string;
     End?: string;
-    Recurrence?: RecurrenceParameter;
+    Recurrence?: RecurrenceParameters;
 };
 
-export type RecurrenceParameter = {
+export type RecurrenceParameters = {
     Pattern: {
         Type: string;
         Interval?: number;