☰
Open navigation menu
RouteMap
View Source
Summary
A map of route names to Route objects or nested route maps.
Signature
interface
RouteMap
<
pattern
>
×
Close navigation menu
Version
3.0.0-alpha.6
(latest)
remix/assert
Classes
AssertionError
Functions
deepEqual
doesNotMatch
doesNotReject
doesNotThrow
equal
fail
match
notDeepEqual
notEqual
ok
rejects
throws
remix/assets
Interfaces
AssetServer
AssetServerOptions
Functions
createAssetServer
remix/async-context-middleware
Types
AsyncRequestContext
Interfaces
AsyncContextTypes
Functions
asyncContext
getContext
remix/auth
Types
OAuthTokens
Interfaces
AtmosphereAuthorizationServerMetadata
AtmosphereAuthProfile
AtmosphereAuthProvider
AtmosphereAuthProviderMapProfileInput
AtmosphereAuthProviderOptions
AtmosphereClientAuthentication
AtmosphereOAuthTokens
AtmosphereTokenAuthorizationServer
Auth0AuthProfile
Auth0AuthProviderOptions
CredentialsAuthProvider
CredentialsAuthProviderOptions
FacebookAuthProfile
FacebookAuthProviderOptions
FacebookAuthProviderPicture
FinishedExternalAuthResult
FinishExternalAuthOptions
GitHubAuthProfile
GitHubAuthProviderEmail
GitHubAuthProviderOptions
GoogleAuthProfile
GoogleAuthProviderOptions
MicrosoftAuthProfile
MicrosoftAuthProviderOptions
OAuthAccount
OAuthDpopBinding
OAuthDpopTokens
OAuthProvider
OAuthResult
OAuthStandardTokens
OIDCAuthProfile
OIDCAuthProviderMetadata
OIDCAuthProviderOptions
OktaAuthProfile
OktaAuthProviderOptions
RefreshedExternalAuthResult
StartExternalAuthOptions
XAuthProfile
XAuthProviderOptions
Functions
completeAuth
createAtmosphereAuthProvider
createAuth0AuthProvider
createCredentialsAuthProvider
createFacebookAuthProvider
createGitHubAuthProvider
createGoogleAuthProvider
createMicrosoftAuthProvider
createOIDCAuthProvider
createOktaAuthProvider
createXAuthProvider
finishExternalAuth
refreshExternalAuth
startExternalAuth
verifyCredentials
remix/auth-middleware
Types
AuthSchemeAuthenticateResult
AuthSchemeResult
AuthState
WithAuth
WithRequiredAuth
Interfaces
APIAuthSchemeOptions
AuthFailure
AuthOptions
AuthScheme
AuthSchemeFailure
AuthSchemeSuccess
BadAuth
BearerTokenAuthSchemeOptions
GoodAuth
RequireAuthOptions
SessionAuthSchemeOptions
Functions
auth
createAPIAuthScheme
createBearerTokenAuthScheme
createSessionAuthScheme
requireAuth
remix/cli
Interfaces
RunRemixOptions
remix/compression-middleware
Interfaces
CompressionOptions
Functions
compression
remix/cookie
Interfaces
CookieOptions
Classes
Cookie
Functions
createCookie
remix/cop-middleware
Types
CopFailureReason
Interfaces
CopOptions
Functions
cop
CopDenyHandler
remix/cors-middleware
Types
CorsAllowedHeadersResolverResult
CorsOrigin
CorsOriginResolverResult
Interfaces
CorsOptions
Functions
cors
CorsAllowedHeadersResolver
CorsOriginResolver
remix/csrf-middleware
Types
CsrfFailureReason
CsrfOrigin
CsrfOriginResolverResult
CsrfTokenResolverResult
Interfaces
CsrfOptions
Functions
csrf
CsrfOriginResolver
CsrfTokenResolver
getCsrfToken
remix/data-schema
Types
Check
ErrorMap
ErrorMapContext
InferInput
InferOutput
Issue
ParseOptions
Schema
ValidationOptions
ValidationResult
Classes
ValidationError
Functions
any
array
bigint
boolean
createIssue
createSchema
defaulted
enum_
fail
instanceof_
literal
map
null_
nullable
number
object
optional
parse
parseSafe
record
set
string
symbol
tuple
undefined_
union
variant
remix/data-schema/checks
Functions
email
max
maxLength
min
minLength
url
remix/data-schema/coerce
Functions
bigint
boolean
date
number
string
remix/data-schema/form-data
Types
FormDataObjectSchema
FormDataSchema
FormDataSource
ParsedFormData
Interfaces
FormDataEntrySchema
FormDataFieldOptions
FormDataFieldsOptions
FormDataFileOptions
FormDataFilesOptions
Functions
field
fields
file
files
object
remix/data-schema/lazy
Functions
lazy
remix/data-table
Types
AdapterCapabilities
AdapterCapabilityOverrides
AddCheckChange
AddCheckOperation
AddColumnChange
AddForeignKeyChange
AddForeignKeyOperation
AddPrimaryKeyChange
AddUniqueChange
AlterTableChange
AlterTableOperation
AnyColumn
AnyQuery
AnyRelation
AnyTable
BelongsToOptions
ChangeColumnChange
CheckConstraint
ColumnCheck
ColumnComputed
ColumnDefault
ColumnDefinition
ColumnNamespace
ColumnReference
ColumnReferenceForQualifiedName
ColumnTypeName
CountOperation
CountOptions
CreateIndexOperation
CreateManyResultOptions
CreateManyRowsOptions
CreateResultOptions
CreateRowOptions
CreateTableOperation
DataManipulationOperation
DataManipulationRequest
DataManipulationResult
DataMigrationOperation
DataMigrationRequest
DataMigrationResult
DeleteManyOptions
DeleteOperation
DropCheckChange
DropCheckOperation
DropColumnChange
DropForeignKeyChange
DropForeignKeyOperation
DropIndexOperation
DropPrimaryKeyChange
DropTableOperation
DropUniqueChange
ExistsOperation
FindManyOptions
FindOneOptions
ForeignKeyAction
ForeignKeyConstraint
HasManyOptions
HasManyThroughOptions
HasOneOptions
IndexDefinition
IndexMethod
InsertManyOperation
InsertOperation
JoinClause
JoinType
KeySelector
OrderByClause
OrderByInput
OrderByTuple
OrderDirection
Predicate
PrimaryKeyConstraint
PrimaryKeyInput
QueryColumnTypesForTable
QueryForTable
QueryTableInput
RawOperation
Relation
RelationCardinality
RelationKind
RelationMapForTable
RenameColumnChange
RenameIndexOperation
RenameTableOperation
ReturningSelection
SelectColumn
SelectOperation
SetTableCommentChange
SingleTableColumn
SingleTableWhere
SqlStatement
Table
TableAfterDelete
TableAfterDeleteContext
TableAfterRead
TableAfterReadContext
TableAfterReadResult
TableAfterWrite
TableAfterWriteContext
TableBeforeDelete
TableBeforeDeleteContext
TableBeforeDeleteResult
TableBeforeWrite
TableBeforeWriteContext
TableBeforeWriteResult
TableColumnInput
TableColumnName
TableColumns
TableColumnsDefinition
TableLifecycleOperation
TableName
TablePrimaryKey
TableRef
TableReference
TableRow
TableRowWith
TableValidate
TableValidationContext
TableValidationOperation
TableValidationResult
TableWriteOperation
TimestampConfig
TimestampOptions
TransactionOptions
TransactionToken
UniqueConstraint
UpdateManyOptions
UpdateOperation
UpdateOptions
UpsertOperation
ValidationFailure
ValidationIssue
WhereInput
WhereObject
WriteResult
WriteRowResult
WriteRowsResult
Interfaces
DatabaseAdapter
Classes
ColumnBuilder
Database
DataTableAdapterError
DataTableConstraintError
DataTableError
DataTableQueryError
DataTableValidationError
Functions
and
belongsTo
between
createDatabase
eq
fail
getTableAfterDelete
getTableAfterRead
getTableAfterWrite
getTableBeforeDelete
getTableBeforeWrite
getTableColumnDefinitions
getTableColumns
getTableName
getTablePrimaryKey
getTableReference
getTableTimestamps
getTableValidator
gt
gte
hasMany
hasManyThrough
hasOne
ilike
inList
isNull
like
lt
lte
ne
notInList
notNull
or
rawSql
sql
table
timestamps
remix/data-table-mysql
Classes
MysqlDatabaseAdapter
Functions
createMysqlDatabaseAdapter
remix/data-table-postgres
Classes
PostgresDatabaseAdapter
Functions
createPostgresDatabaseAdapter
remix/data-table-sqlite
Interfaces
SqliteDatabase
SqliteRunResult
SqliteStatement
Classes
SqliteDatabaseAdapter
Functions
createSqliteDatabaseAdapter
remix/data-table/migrations
Types
CreateMigrationInput
KeyColumns
MigrateOptions
MigrateResult
Migration
MigrationContext
MigrationDescriptor
MigrationDirection
MigrationJournalRow
MigrationRegistry
MigrationRunner
MigrationRunnerOptions
MigrationStatus
MigrationStatusEntry
MigrationTransactionMode
TableInput
Interfaces
AlterTableBuilder
MigrationSchema
Functions
createMigration
createMigrationRegistry
createMigrationRunner
parseMigrationFilename
remix/data-table/migrations/node
Functions
loadMigrations
remix/data-table/operators
Functions
and
between
eq
gt
gte
ilike
inList
isNull
like
lt
lte
ne
notInList
notNull
or
remix/data-table/sql-helpers
Types
QuoteIdentifier
Functions
collectColumns
isDataManipulationOperation
normalizeJoinType
quoteLiteral
quotePath
quoteTableRef
remix/fetch-proxy
Interfaces
FetchProxyOptions
Functions
createFetchProxy
FetchProxy
remix/fetch-router
Types
Action
AnyParams
ApplyContextTransform
ApplyMiddleware
ApplyMiddlewareTuple
BuildAction
ContextEntries
ContextEntry
ContextValue
Controller
GetContextValue
MatchData
MergeContext
MiddlewareContext
MiddlewareContextTransform
NextFunction
RequestMethod
SetContextValue
WithParams
Interfaces
Router
RouterOptions
Classes
RequestContext
Functions
createContextKey
createRouter
Middleware
RequestHandler
remix/fetch-router/routes
Types
BuildRoute
ResourceMethod
ResourceOptions
ResourcesMethod
ResourcesOptions
RouteDef
Interfaces
FormOptions
RouteDefs
RouteMap
Classes
Route
Functions
createDeleteRoute
createFormRoutes
createGetRoute
createHeadRoute
createOptionsRoute
createPatchRoute
createPostRoute
createPutRoute
createResourceRoutes
createResourcesRoutes
createRoutes
form
resource
resources
route
remix/file-storage
Interfaces
FileKey
FileMetadata
FileStorage
ListOptions
ListResult
remix/file-storage-s3
Interfaces
S3FileStorageOptions
Functions
createS3FileStorage
remix/file-storage/fs
Functions
createFsFileStorage
remix/file-storage/memory
Functions
createMemoryFileStorage
remix/form-data-middleware
Interfaces
FileUpload
FormDataOptions
Classes
FormDataParseError
Functions
FileUploadHandler
formData
remix/form-data-parser
Interfaces
ParseFormDataOptions
Classes
MaxFilesExceededError
MaxFileSizeExceededError
MaxHeaderSizeExceededError
MaxPartsExceededError
MaxTotalSizeExceededError
MultipartParseError
Functions
FileUploadHandler
parseFormData
remix/fs
Interfaces
OpenLazyFileOptions
Functions
openLazyFile
writeFile
remix/headers
Types
AcceptEncodingInit
AcceptInit
AcceptLanguageInit
CookieInit
Interfaces
CacheControlInit
ContentDispositionInit
ContentRangeInit
ContentTypeInit
CookieProperties
IfMatchInit
IfNoneMatchInit
RangeInit
SetCookieInit
VaryInit
Classes
Accept
AcceptEncoding
AcceptLanguage
CacheControl
ContentDisposition
ContentRange
ContentType
Cookie
IfMatch
IfNoneMatch
IfRange
Range
SetCookie
Vary
Functions
parse
stringify
remix/html-template
Types
SafeHtml
Functions
isSafeHtml
remix/lazy-file
Interfaces
ByteRange
LazyBlobOptions
LazyContent
LazyFileOptions
Classes
LazyBlob
LazyFile
Functions
getByteLength
getIndexes
remix/logger-middleware
Interfaces
LoggerOptions
Functions
logger
remix/method-override-middleware
Interfaces
MethodOverrideOptions
Functions
methodOverride
remix/mime
Interfaces
MimeTypeDefinition
Functions
defineMimeType
detectContentType
detectMimeType
isCompressibleMimeType
mimeTypeToContentType
remix/multipart-parser
Types
MultipartParserOptions
Interfaces
MultipartHeaders
ParseMultipartOptions
Classes
MultipartParser
MultipartPart
Functions
getMultipartBoundary
isMultipartRequest
parseMultipart
parseMultipartRequest
parseMultipartStream
remix/multipart-parser/node
Functions
getMultipartBoundary
isMultipartRequest
parseMultipart
parseMultipartRequest
parseMultipartStream
remix/node-fetch-server
Types
RequestOptions
Interfaces
ClientAddress
RequestListenerOptions
Functions
createHeaders
createRequest
createRequestListener
ErrorHandler
FetchHandler
sendResponse
remix/node-fetch-server/test
Interfaces
TestServer
Functions
createTestServer
remix/response/compress
Types
Encoding
Interfaces
CompressResponseOptions
Functions
compressResponse
remix/response/file
Types
FileDigestFunction
Interfaces
FileResponseOptions
Functions
createFileResponse
remix/response/html
Functions
createHtmlResponse
remix/response/redirect
Functions
createRedirectResponse
remix/route-pattern
Types
HrefArgs
Join
Match
Matcher
Params
RoutePatternMatch
Classes
ArrayMatcher
HrefError
ParseError
RoutePattern
TrieMatcher
remix/route-pattern/specificity
Functions
ascending
compare
descending
equal
greaterThan
lessThan
remix/session
Interfaces
SessionStorage
Classes
Session
Functions
createSession
createSessionId
remix/session-middleware
Functions
session
remix/session-storage-memcache
Interfaces
MemcacheSessionStorageOptions
Functions
createMemcacheSessionStorage
remix/session-storage-redis
Interfaces
RedisSessionStorageClient
RedisSessionStorageOptions
Functions
createRedisSessionStorage
remix/session/cookie-storage
Functions
createCookieSessionStorage
remix/session/fs-storage
Interfaces
FsSessionStorageOptions
Functions
createFsSessionStorage
remix/session/memory-storage
Functions
createMemorySessionStorage
remix/static-middleware
Interfaces
StaticFilesOptions
Functions
staticFiles
remix/tar-parser
Types
ParseTarOptions
TarParserOptions
Interfaces
ParseTarHeaderOptions
TarHeader
Classes
TarEntry
TarParseError
TarParser
Functions
parseTar
parseTarHeader
remix/terminal
Types
TerminalBackgroundColorName
TerminalEnvironment
TerminalForegroundColorName
TerminalModifierName
TerminalStyle
TerminalStyleName
Interfaces
ColorSupportOptions
CreateStylesOptions
Terminal
TerminalInputStream
TerminalOptions
TerminalOutputStream
TerminalStyles
Functions
createStyles
createTerminal
shouldUseColors
stripAnsi
remix/test
Interfaces
FakeTimers
RemixTestConfig
TestContext
Functions
afterAll
afterEach
beforeAll
beforeEach
remix/test/cli
Interfaces
RunRemixTestOptions
remix/ui
Types
AppRuntime
AppRuntimeEventMap
ComponentErrorEvent
CSSMixinDescriptor
Dispatched
EntryComponent
FrameContent
FrameHandle
FrameHandleEventMap
LoadModule
MixinDescriptor
MixinHandle
MixInput
MixinType
MixValue
NavigationOptions
RefCallback
ResolveFrame
RunInit
Scheduler
SerializableArray
SerializableObject
SerializablePrimitive
SerializableProps
SerializableValue
Task
VirtualRoot
VirtualRootEventMap
VirtualRootOptions
Interfaces
Context
FrameProps
Handle
HostProps
LayoutAnimationConfig
Classes
TypedEventTarget
Functions
addEventListeners
attrs
clientEntry
createElement
createMixin
createRangeRoot
createRoot
createScheduler
Fragment
Frame
navigate
on
run
remix/ui/accordion
Types
AccordionContentProps
AccordionItemProps
AccordionMultipleProps
AccordionProps
AccordionSingleProps
AccordionTriggerProps
remix/ui/anchor
Types
AnchorOptions
AnchorPlacement
remix/ui/animation
Types
SpringPreset
Interfaces
BezierCurve
SpringIterator
SpringOptions
TweenOptions
Functions
animateEntrance
animateExit
animateLayout
spring
tween
remix/ui/breadcrumbs
Types
BreadcrumbItem
BreadcrumbsProps
remix/ui/button
Types
ButtonProps
ButtonTone
remix/ui/combobox
Types
ComboboxOpenStrategy
Interfaces
ComboboxContextProps
ComboboxHandle
ComboboxOptionOptions
ComboboxOptionProps
ComboboxProps
remix/ui/glyph
Types
GlyphName
GlyphProps
GlyphSheetComponent
GlyphSheetProps
GlyphSymbol
GlyphValues
remix/ui/jsx-dev-runtime
Types
ElementProps
ElementType
Props
RemixNode
Renderable
Interfaces
RemixElement
Functions
Fragment
jsx
jsxDEV
jsxs
remix/ui/jsx-runtime
Functions
Fragment
jsx
jsxDEV
jsxs
remix/ui/listbox
Types
ListboxValue
Interfaces
ListboxContext
ListboxOption
ListboxProviderProps
ListboxRef
ListboxRegisteredOption
remix/ui/menu
Interfaces
MenuItemOptions
MenuItemProps
MenuListProps
MenuProps
MenuProviderProps
MenuSelectItem
MenuTriggerOptions
SubmenuProps
SubmenuTriggerOptions
remix/ui/popover
Interfaces
PopoverContext
PopoverHideRequest
PopoverProps
PopoverSurfaceOptions
remix/ui/select
Types
SelectOptionProps
Interfaces
SelectContextProps
SelectProps
remix/ui/server
Interfaces
RenderToStreamOptions
ResolveFrameContext
Functions
renderToStream
renderToString
remix/ui/test
Interfaces
RenderOptions
RenderResult
Functions
render
remix/ui/theme
Types
CreateThemeOptions
GlyphContract
ThemeComponent
ThemeMix
ThemeStyleProps
ThemeUtility
ThemeValue
ThemeValues
ThemeVars
