Merge pull request #3 from hbjorgo/ConstantTime

Constant time

Author: hbjorgo

src/HeboTech.TimeService/HeboTech.TimeService.csproj

@@ -10,7 +10,7 @@
     <PackageReleaseNotes>https://github.com/hbjorgo/TimeService/releases</PackageReleaseNotes>
     <PackageTags>time timeservice time-service timefunc time-func</PackageTags>
     <RepositoryUrl>https://github.com/hbjorgo/TimeService</RepositoryUrl>
-    <Version>1.0.1</Version>
+    <Version>1.1.0</Version>
   </PropertyGroup>
 
 </Project>

src/HeboTech.TimeService/TimeProviders.cs

@@ -4,7 +4,14 @@ namespace HeboTech.TimeService
 {
     public class TimeProviders
     {
+        /// <summary>
+        /// Returns DateTime.Now
+        /// </summary>
         public static Func<DateTime> SystemTime => () => DateTime.Now;
+
+        /// <summary>
+        /// Returns DateTime.UtcNow
+        /// </summary>
         public static Func<DateTime> SystemTimeUtc => () => DateTime.UtcNow;
     }
 }

src/HeboTech.TimeService/TimeService.cs

@@ -5,9 +5,24 @@ namespace HeboTech.TimeService
     public static class TimeService
     {
         private static Func<DateTime> timeFunc;
+
+        /// <summary>
+        /// Gets a DateTime object that represents the current time
+        /// </summary>
         public static DateTime Now => timeFunc();
 
+        /// <summary>
+        /// Sets the current time. The func can either return a constant time, or a dynamic one (like DateTime.Now).
+        /// </summary>
+        /// <param name="timeFunc">Func that returns the current time</param>
         public static void Set(Func<DateTime> timeFunc) =>
             TimeService.timeFunc = timeFunc ?? throw new ArgumentNullException(nameof(timeFunc));
+
+        /// <summary>
+        /// Sets the current (constant) time.
+        /// </summary>
+        /// <param name="now">The current (constant) time</param>
+        public static void SetConstant(DateTime now) =>
+            timeFunc = () => now;
     }
 }