remix/routes · InterfaceRouteMap

Version

3.0.0-beta.0 (latest)

remix

remix/assert

Interfaces

Classes

Functions

assert deepEqual doesNotMatch doesNotReject doesNotThrow equal expect 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

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 ContextWithAuth ContextWithRequiredAuth

Interfaces

APIAuthSchemeOptions AuthFailure AuthOptions AuthScheme AuthSchemeFailure AuthSchemeSuccess BadAuth BearerTokenAuthSchemeOptions GoodAuth RequireAuthOptions SessionAuthSchemeOptions

Functions

auth createAPIAuthScheme createBearerTokenAuthScheme createSessionAuthScheme requireAuth

Variables

remix/cli

Interfaces

RunRemixOptions

Functions

remix/compression-middleware

Interfaces

CompressionOptions

Functions

remix/cookie

Interfaces

Classes

Functions

remix/cop-middleware

Types

CopFailureReason

Interfaces

Functions

cop CopDenyHandler

remix/cors-middleware

Types

CorsAllowedHeadersResolverResult CorsOrigin CorsOriginResolverResult

Interfaces

Functions

cors CorsAllowedHeadersResolver CorsOriginResolver

remix/csrf-middleware

Types

CsrfFailureReason CsrfOrigin CsrfOriginResolverResult CsrfTokenResolverResult

Interfaces

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

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 Query

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 query rawSql sql table timestamps

Variables

column columnMetadataKey tableMetadataKey

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

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 ContextEntries ContextEntry ContextValue ContextWithMiddleware ContextWithParams ContextWithValue ContextWithValues Controller GetContextValue MiddlewareContext NextFunction RequestMethod

Interfaces

RouteEntry Router RouterOptions RouterTypes

Classes

Functions

createAction createContextKey createController createRouter isRequestMethod Middleware RequestHandler

Variables

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

FileUpload FormDataParseError MaxFilesExceededError MaxFileSizeExceededError MaxHeaderSizeExceededError MaxPartsExceededError MaxTotalSizeExceededError MultipartParseError

Functions

FileUploadHandler parseFormData

remix/fs

Interfaces

OpenLazyFileOptions

Functions

openLazyFile writeFile

remix/headers

Types

AcceptEncodingInit AcceptInit AcceptLanguageInit CookieInit SuperHeadersInit

Interfaces

CacheControlInit ContentDispositionInit ContentRangeInit ContentTypeInit CookieProperties IfMatchInit IfNoneMatchInit RangeInit SetCookieInit SuperHeadersPropertyInit VaryInit

Classes

Accept AcceptEncoding AcceptLanguage CacheControl ContentDisposition ContentRange ContentType Cookie IfMatch IfNoneMatch IfRange Range SetCookie SuperHeaders Vary

Functions

parse stringify

remix/html-template

Types

Functions

html isSafeHtml

remix/lazy-file

Interfaces

ByteRange LazyBlobOptions LazyContent LazyFileOptions

Classes

LazyBlob LazyFile

Functions

getByteLength getIndexes

remix/logger-middleware

Interfaces

Functions

remix/method-override-middleware

Interfaces

MethodOverrideOptions

Functions

remix/mime

Interfaces

MimeTypeDefinition

Functions

defineMimeType detectContentType detectMimeType isCompressibleMimeType mimeTypeToContentType

remix/multipart-parser

Types

MultipartParserOptions

Interfaces

MultipartHeaders ParseMultipartOptions

Classes

MaxFileSizeExceededError MaxHeaderSizeExceededError MaxPartsExceededError MaxTotalSizeExceededError MultipartParseError MultipartParser MultipartPart

Functions

getMultipartBoundary isMultipartRequest parseMultipart parseMultipartRequest parseMultipartStream

remix/multipart-parser/node

Functions

getMultipartBoundary isMultipartRequest parseMultipart parseMultipartRequest parseMultipartStream

remix/node-fetch-server

Types

Interfaces

ClientAddress RequestListenerOptions

Functions

createHeaders createRequest createRequestListener ErrorHandler FetchHandler sendResponse

remix/node-fetch-server/test

Interfaces

Functions

createTestServer

remix/node-serve

Interfaces

ClientAddress ServeOptions Server ServeTlsOptions UwsRequestHandlerOptions

Functions

createUwsRequestHandler ErrorHandler FetchHandler serve UwsRequestHandler

remix/response

remix/response/compress

Types

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

HrefError ParseError RoutePattern

Functions

remix/route-pattern/specificity

Functions

ascending compare descending equal greaterThan lessThan

remix/routes

Types

BuildRoute RequestBodyMethod RequestMethod ResourceMethod ResourceOptions ResourcesMethod ResourcesOptions RouteDef

Interfaces

FormOptions RouteDefs RouteMap

Classes

Functions

createDeleteRoute createFormRoutes createGetRoute createHeadRoute createOptionsRoute createPatchRoute createPostRoute createPutRoute createResourceRoutes createResourcesRoutes createRoutes form resource resources route

Variables

RequestBodyMethods RequestMethods

remix/session

Interfaces

Classes

Functions

createSession createSessionId

remix/session-middleware

Functions

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

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

Variables

remix/test

Types

Interfaces

FakeTimers RemixTestConfig TestContext

Functions

after afterAll afterEach before beforeAll beforeEach describe it suite test

Variables

remix/test/cli

Interfaces

RunRemixTestOptions

Functions

getRemixTestHelpText runRemixTest

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 css Fragment Frame link navigate on ref run

remix/ui/accordion

Types

AccordionContentProps AccordionItemProps AccordionMultipleProps AccordionProps AccordionSingleProps AccordionTriggerProps

remix/ui/anchor

Types

AnchorOptions AnchorPlacement

remix/ui/animation

Types

Interfaces

BezierCurve SpringIterator SpringOptions TweenOptions

Functions

animateEntrance animateExit animateLayout spring tween

Variables

remix/ui/breadcrumbs

Types

BreadcrumbItem BreadcrumbsProps

remix/ui/button

Types

ButtonProps ButtonTone

Functions

Mixins

baseStyle dangerStyle ghostStyle iconStyle labelStyle primaryStyle secondaryStyle

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

Functions

Fragment jsx jsxDEV jsxs

remix/ui/jsx-runtime

Functions

Fragment jsx jsxDEV jsxs

remix/ui/listbox

Types

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

remix/ui/theme

Types

CreateThemeOptions GlyphContract ThemeComponent ThemeMix ThemeStyleProps ThemeUtility ThemeValue ThemeValues ThemeVars

remix/routes · InterfaceView Source

RouteMap

Summary

A map of route names to Route objects or nested route maps.

Signature

interface RouteMap<pattern>

docs and examples licensed under mit©2026 Shopify, Inc.