Skip to content

Vapor API Docs

LeafKit

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

Classes
DefaultLeafCache
- Initializers
- init()
- Instance Properties
- var count: Int
- var isEnabled: Bool
- Instance Methods
- func insert(LeafAST, on: any EventLoop, replace: Bool) -> EventLoopFuture<LeafAST>
- func remove(String, on: any EventLoop) -> EventLoopFuture<Bool?>
- func retrieve(documentName: String, on: any EventLoop) -> EventLoopFuture<LeafAST?>
LeafRenderer
LeafSources
- Initializers
- init()
- Instance Properties
- var all: Set<String>
- var searchOrder: [String]
- Instance Methods
- func register(source: String, using: any LeafSource, searchable: Bool) throws
- Type Methods
- static func singleSource(any LeafSource) -> LeafSources
Protocols
LeafCache
- Instance Properties
- var count: Int
- var isEnabled: Bool
- Instance Methods
- func insert(LeafAST, on: any EventLoop, replace: Bool) -> EventLoopFuture<LeafAST>
- func remove(String, on: any EventLoop) -> EventLoopFuture<Bool?>
- func retrieve(documentName: String, on: any EventLoop) -> EventLoopFuture<LeafAST?>
LeafDataRepresentable
- Instance Properties
- var leafData: LeafData
LeafSource
- Instance Methods
- func file(template: String, escape: Bool, on: any EventLoop) throws -> EventLoopFuture<ByteBuffer>
LeafTag
- Instance Methods
- func render(LeafContext) throws -> LeafData
UnsafeUnescapedLeafTag
Structures
LeafAST
- Operators
- static func == (LeafAST, LeafAST) -> Bool
- Instance Methods
- func hash(into: inout Hasher)
LeafConfiguration
LeafContext
- Instance Properties
- let body: [Syntax]?
- let data: [String : LeafData]
- let parameters: [LeafData]
- let userInfo: [AnyHashable : Any]
- Instance Methods
- func requireBody() throws -> [Syntax]
- func requireNoBody() throws
- func requireParameterCount(Int) throws
LeafData
LeafError
LexerError
NIOLeafFiles
Variables
var defaultTags: [String : any LeafTag]
Enumerations
ConditionalSyntax
- Enumeration Cases
- case `else`
- case elseif([ParameterDeclaration])
- case `if`([ParameterDeclaration])
Constant
- Enumeration Cases
- case double(Double)
- case int(Int)
- Instance Properties
- var description: String
LeafKeyword
- Enumeration Cases
- case `false`
- case `in`
- case `nil`
- case no
- case this
- case `true`
- case yes
- Initializers
- init?(rawValue: String)
LeafOperator
- Enumeration Cases
- case and
- case assignment
- case divide
- case equal
- case evaluate
- case greater
- case greaterOrEqual
- case lesser
- case lesserOrEqual
- case minus
- case modulo
- case multiply
- case nilCoalesce
- case not
- case or
- case plus
- case scopeMember
- case scopeRoot
- case subClose
- case subOpen
- case unequal
- Initializers
- init?(rawValue: String)
- Instance Properties
- var description: String
Parameter
- Enumeration Cases
- case constant(Constant)
- case keyword(LeafKeyword)
- case `operator`(LeafOperator)
- case stringLiteral(String)
- case tag(name: String)
- case variable(name: String)
- Instance Properties
- var description: String
ParameterDeclaration
- Enumeration Cases
- case expression([ParameterDeclaration])
- case parameter(Parameter)
- case tag(Syntax.CustomTagDeclaration)
- Instance Properties
- var description: String
Syntax
Extended Modules
Foundation
Swift

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

Case

Parameter.tag(name:)

case tag(name: String)

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