generated from PSModule/Template-Docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Description
Describe the change
Describe the change
Standardize the name of all the DateTime and TimeSpan based properties on classes and objects that are managed by the module.
Naming Convention:
- Specific Point in Time (timestamp)
- Pattern:
EventName + At - Examples:
ExpiresAtResetAt
- Pattern:
- Events Before or After a Specific Time (timestamp)
- Pattern:
EventName + BeforeorEventName + After - Examples:
ResetBeforeExpiresAfter
- Pattern:
- Time Relative to a Given Time (timespan)
- In the future
- Pattern:
EventName + In - Examples:
ExpiresInResetIn
- Pattern:
- In the past
- Pattern:
EventName + Ago - Examples:
ResetAgoExpiredAgo
- Pattern:
- In the future
Calculation Rules:
- Ideally, both a timestamp and a timespan should be provided or calculated.
- If
ExpiresAtis provided, calculateExpiresIn. - If
ExpiresInis provided, calculateExpiresAt. - If only one is available, the other should be derived.
- If
Example situations to use this
- Token Expiration
- Refresh Token Expiration
- Rate Limit reset
- Creation time of a repo (back in time)
- Update time of a team (back in time)
Metadata
Metadata
Assignees
Labels
No labels