VaporExt is a collection of Swift extensions, with handy methods, syntactic sugar, and performance improvements for wide range of Vapor types and classes.
You can use The Swift Package Manager to install VaporExt
by adding the proper description to your Package.swift
file:
import PackageDescription
let package = Package(
name: "YOUR_PROJECT_NAME",
targets: [],
dependencies: [
.package(url: "https://github.com/vapor-community/vapor-ext.git", from: "0.1.0"),
]
)
Note that the Swift Package Manager is still in early design and development, for more information checkout its GitHub Page
The extensions are grouped in 3 modules, AsyncExt
, FluentExt
and ServiceExt
, and the VaporExt
which acts as a helper to export the extensions included in the previous packages.
true(or error:)
false(or error:)
greater(than value:)
greater(than value:, or error:)
greaterOrEqual(to value:)
greaterOrEqual(to value:, or error:)
less(than value:)
less(than value:, or error:)
lessOrEqual(to value:)
lessOrEqual(to value:, or error:)
equal(to value:)
equal(to value:, or error:)
notEqual(to value:)
notEqual(to value:, or error:)
query(by:, on:, withSoftDeleted:)
to create a query for the model and apply a filter of criteria.findAll(sortBy:, on:, withSoftDeleted:)
to find all models and apply some sorting criteria.find(by:, sortBy:, on:, withSoftDeleted:)
to find models and apply some filters and sorting criteria.findOne(by:, on:, withSoftDeleted:)
to find first model that matches the filters criteria.count(on:, withSoftDeleted:)
to count the number of registers of the model.count(by:, on:, withSoftDeleted:)
to count the number of registers of the model that matches some criteria.!~=
for not has suffix comparison.!=~
for not has prefix comparison.!~~
for not contains comparison.filter(keyPath:, at parameter:, on req:)
to handle automatic filters based in query params.sort(keyPath:, at queryParam:, as parameter:, default direction:, on req:)
to handle automatic sorting based in query params.sort(keyPath:, as parameter:, default direction:, on req:)
to handle automatic sorting based in query params.sort(by:)
to apply some sorting criteria.filter(keyPath:, at parameter:)
to build FilterOperator based in query params.sort(keyPath:, at queryParam:, as parameter:)
to build QuerySort based in query params.sort(keyPath:, at queryParam:, as parameter:, default direction:)
to build QuerySort based in query params.sort(keyPath:, as parameter:)
to build QuerySort based in query params.sort(keyPath:, as parameter:, default direction:)
to build QuerySort based in query params.You can set the filter method with this format parameter=method:value
and the new filter method will build the filter based on the method
, example:
[email protected]
or username=eq:[email protected]
will use equal
comparison.username=neq:[email protected]
will use not equal
comparison.username=in:[email protected],[email protected]
will use in
comparison.username=nin:[email protected],[email protected]
will use not in
comparison.price=gt:3000
will use greater than
comparison.price=gte:3000
will use greater than or equal
comparison.price=lt:3000
will use less than
comparison.price=lte:3000
will use less than or equal
comparison.username=sw:example
will filter using starts with
comparison.username=nsw:example
will filter using not starts with
comparison.username=ew:domain.com
will filter using ends with
comparison.username=new:domain.com
will filter using not ends with
comparison.username=ct:domain.com
will filter using contains
comparison.username=nct:domain.com
will filter using not contains
comparison.return try User.query(on: req)
.filter(\User.username, at: "username", on: req)
.filter(\User.enabled, at: "enabled", on: req)
.filter(\User.createdAt, at: "created_at", on: req)
.filter(\User.updatedAt, at: "updated_at", on: req)
.filter(\User.deletedAt, at: "deleted_at", on: req)
You can set the sorts methods with this format sort=field:direction,field:direction
and the new sort method will build the query based on that configuration, for example
sort=username:asc,created_at:desc
you can get you users sorted by username with ASC direction and firstname in DESC directionreturn try User.query(on: req)
.sort(\User.username, as: "username", on: req)
.sort(\User.createdAt, as: "created_at", default: .ascending, on: req) // if created_at is not present in the url, then the sort is applied using the default direction
func index(_ req: Request) throws -> Future<[User]> {
let repository = try req.make(UserRepository.self)
let criteria: [FilterOperator<User.Database, User>] = try [
req.filter(\User.name, at: "name"),
req.filter(\User.username, at: "username"),
req.filter(\User.enabled, at: "enabled")
].compactMap { $0 }
var sort: [User.Database.QuerySort] = try [
req.sort(\User.name, as: "name"),
req.sort(\User.username, as: "username"),
req.sort(\User.createdAt, as: "created_at"),
].compactMap { $0 }
if sort.isEmpty {
let defaultSort = try req.sort(\User.name, as: "name", default: .ascending)
sort.append(defaultSort)
}
return repository.findBy(criteria: criteria, orderBy: sort, on: req)
}
dotenv(filename:)
to add .env
support!get(_ key:)
method to get values as Int and Boolget(_ key:, _ fallback:)
method to get values as Int and Bool and String, with a fallback valuestoResponse(on req:, as status:, contentType:)
to transform a FutureWe want your feedback. Please refer to contributing guidelines before participating.
It is always nice to talk with other people using VaporExt and exchange experiences, so come join our Discord channel.
This package is developed and maintained by Gustavo Perdomo with the collaboration of all vapor community.
VaporExt is released under an MIT license. See license for more information.
link |
Stars: 36 |
Last commit: 4 years ago |
# Changes:
Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics