Skip to content

Vapor API Docs

Fluent

Core

Vapor AsyncKit RoutingKit ConsoleKit ConsoleLogger beta WebSocketKit MultipartKit

Authentication

JWT JWTKit Authentication

Templating

Leaf LeafKit

Database

Fluent FluentKit FluentSQL FluentPostgresDriver FluentMongoDriver FluentMySQLDriver FluentSQLiteDriver SQLKit PostgresKit MySQLKit SQLiteKit PostgresNIO MySQLNIO SQLiteNIO Redis

Queues

Queues QueuesRedisDriver

Push Notifications

APNS

Testing

XCTVapor VaporTesting XCTFluent XCTQueues

Fluent

Classes
CacheEntry
- Initializers
- init()
- init(id: UUID?, key: String, value: String)
- Instance Properties
- var id: UUID?
- var key: String
- var value: String
- Type Properties
- static var migration: any Migration
- static let schema: String
MigrateCommand
- Structures
- MigrateCommand.Signature
  - Initializers
  - init()
- Instance Properties
- var help: String
- let signature: MigrateCommand.Signature
- Instance Methods
- func run(using: CommandContext, signature: MigrateCommand.Signature) async throws
SessionRecord
- Initializers
- init()
- init(id: UUID?, key: SessionID, data: SessionData)
- Instance Properties
- var data: SessionData
- var id: UUID?
- var key: SessionID
- Type Properties
- static var migration: any Migration
- static let schema: String
Protocols
ModelAuthenticatable
- Instance Methods
- func verify(password: String) throws -> Bool
- Type Properties
- static var passwordHashKey: KeyPath<Self, FieldProperty<Self, String>>
- static var usernameKey: KeyPath<Self, FieldProperty<Self, String>>
- Type Methods
- static func authenticator(database: DatabaseID?) -> any Authenticator
ModelCredentialsAuthenticatable
- Instance Methods
- func verify(password: String) throws -> Bool
- Type Properties
- static var passwordHashKey: KeyPath<Self, Self.Field<String>>
- static var usernameKey: KeyPath<Self, Self.Field<String>>
- Type Methods
- static func asyncCredentialsAuthenticator(DatabaseID?) -> any AsyncAuthenticator
- static func credentialsAuthenticator(database: DatabaseID?) -> any Authenticator
ModelSessionAuthenticatable
ModelTokenAuthenticatable
- Associated Types
- User
- Instance Properties
- var isValid: Bool
- Type Properties
- static var userKey: KeyPath<Self, Self.Parent<Self.User>>
- static var valueKey: KeyPath<Self, Self.Field<String>>
- Type Methods
- static func authenticator(database: DatabaseID?) -> any Authenticator
Structures
ModelCredentials
- Initializers
- init(from: any Decoder) throws
- init(username: String, password: String)
- Instance Properties
- let password: String
- let username: String
PageLimit
- Initializers
- init(Int)
- Instance Properties
- let value: Int?
- Type Properties
- static var noLimit: PageLimit
- Default Implementations
- ExpressibleByIntegerLiteral Implementations
  - Initializers
  - init(integerLiteral: IntegerLiteralType)
Extended Modules
FluentKit
Vapor

API Docs
Framework Docs

- API Docs
  
  Reference documentation for Vapor
- Framework Docs
  
  Learn how to use Vapor
Home
Store
Showcase
Team
Blog
GitHub
Theme
- Light
- Dark
- System

Instance Method

paginate(for:)

func paginate(for request: Request) async throws -> Page<Model>

Vapor

Reference documentation for Vapor and its ecosystem.

Community

Team
Join our Discord
Store
Showcase
Supporters

Resources

Blog
Framework Docs
API Docs
Press Kit
Help

Twitter
Mastodon
Bsky
GitHub