This framework is inspired by Moment.js. Its objectives are the following:
- Simplify the manipulation and readability of date and interval values.
- Provide help when parsing dates from various string representations.
- Simplifying the formatting of date information into strings.
- Streamlining getting date components (day, month, etc.) from dates and time intervals.
Important: This framework supports iOS 9+, macOS 10.11+, tvOS 9+, watchOS 2+, Xcode 8 and Swift 3.
SwiftMoment is compatible with Carthage and CocoaPods. With CocoaPods, just add this to your Podfile:
pod 'SwiftMoment'
SwiftMoment can also be used via the Swift Package Manager. Just add it to the dependencies in your Package.swift file:
let package = Package(
name: "MyPackage",
dependencies: [
...
.package(url: "https://github.com/akosma/SwiftMoment.git", from: "0.7.1"),
],
...
)
- Drag the created .framework file into the Xcode Project, be sure to tick 'Copy Files to Directory'
- In the containing applications target, add a new 'Copy File Build Phase'
- Set the 'Destination' to 'Frameworks'
- Drag in the created .framework
To use this library, just import SwiftMoment
in your application.
To create new moment instances:
let now = moment()
let yesterday = moment("2015-01-19")
By default, moments are initialized with the current date and time. You can create moments for any... moment in the future or the past; you can do that by passing strings in different formats:
let yesterday = moment("2015-01-19")
You can also do it by directly specifying the components manually:
let today = moment([2015, 01, 19, 20, 45, 34])
You can also use a dictionary with the following keys:
let obj = moment(["year": 2015,
"second": 34,
"month": 01,
"minute": 45,
"hour": 20,
"day": 19
])
When using a [String: Int]
dictionary, the order of the keys does not
matter. Moreover, only the keys above are taken into account, and any
other information is ignored.
There is also an extension to the Int
type in Swift, used to create
Duration
values directly from an integer value:
let duration = 5.hours + 56.minutes
The two most important components of this library are the Moment
and
Duration
structures. Moment
wraps an NSDate
instance, while
Duration
wraps an NSTimeInterval
value.
Both Moment
and Duration
comply with the Comparable
protocols, and
include all the required operators. In addition, Moment
instances can
be subtracted from one another (which yields a Duration
) and
Duration
instances can be added to Moments
to create new moments.
Moments
and Durations
are made as immutable as possible.
Swift Moment includes a suite of tests showing how to use the different functions of the framework.
To run the Linux tests in a macOS environment, please use the included Dockerfile:
docker build --tag swiftmoment .
docker run --rm swiftmoment
A playground is included in the project to learn how to use the library.
Differences with Moment.js
- Format strings
DD
anddd
do not yield the same results.
Lots of people are actively helping in the development of this library; please check the CONTRIBUTORS file for the full list! Thanks to all :)
This project is distributed under a BSD license. See the LICENSE file for details.