Commit c09330f
committed
Updated API documentation - remix SHA c19b6abbd
1 parent 56b061f commit c09330f
687 files changed
Lines changed: 1151 additions & 1358 deletions
File tree
- docs
- api/remix
- async-context-middleware/function
- asyncContext
- getContext
- component
- function
- clientEntry
- spring
- tween
- interface
- AnimateProp
- Context
- Handle
- LayoutAnimationConfig
- PresenceConfig
- PresenceKeyframeConfig
- PresenceKeyframe
- PresenceOptions
- jsx-dev-runtime
- interface/RemixElement
- type
- ElementProps
- ElementType
- Props
- RemixNode
- Renderable
- type
- EntryComponent
- FrameHandle
- PresenceStyleProperties
- SerializableArray
- SerializableObject
- SerializablePrimitive
- SerializableProps
- SerializableValue
- SpringPreset
- Task
- compression-middleware/function/compression
- cookie
- class/Cookie
- function/createCookie
- interface/CookieOptions
- data-schema
- checks/function
- email
- maxLength
- max
- minLength
- min
- url
- class/ValidationError
- coerce/function
- bigint
- boolean
- date
- number
- string
- function
- any
- array
- bigint
- boolean
- defaulted
- enum_
- instanceof_
- literal
- map
- null_
- nullable
- number
- object
- optional
- parseSafe
- parse
- record
- set
- string
- symbol
- tuple
- undefined_
- union
- variant
- lazy/function/lazy
- type
- Check
- ErrorMapContext
- ErrorMap
- InferInput
- InferOutput
- Issue
- ParseOptions
- Schema
- ValidationOptions
- ValidationResult
- data-table-mysql
- class/MysqlDatabaseAdapter
- function/createMysqlDatabaseAdapter
- type
- MysqlDatabaseAdapterOptions
- MysqlDatabaseConnection
- MysqlDatabasePool
- MysqlQueryResponse
- MysqlQueryResultHeader
- MysqlQueryRows
- data-table-postgres
- class/PostgresDatabaseAdapter
- function/createPostgresDatabaseAdapter
- type
- PostgresDatabaseAdapterOptions
- PostgresDatabaseClient
- PostgresDatabasePool
- PostgresQueryResult
- PostgresTransactionClient
- data-table-sqlite
- class/SqliteDatabaseAdapter
- function/createSqliteDatabaseAdapter
- type
- SqliteDatabaseAdapterOptions
- SqliteDatabaseConnection
- data-table
- class
- DataTableAdapterError
- DataTableConstraintError
- DataTableError
- DataTableQueryError
- DataTableValidationError
- QueryBuilder
- function
- and
- belongsTo
- between
- createDatabase
- createTable
- eq
- getTableColumns
- getTableName
- getTablePrimaryKey
- getTableReference
- getTableTimestamps
- gte
- gt
- hasManyThrough
- hasMany
- hasOne
- ilike
- inList
- isNull
- like
- lte
- lt
- ne
- notInList
- notNull
- or
- rawSql
- sql
- timestampSchema
- timestamps
- interface/DatabaseAdapter
- operators
- function
- and
- between
- eq
- gte
- gt
- ilike
- inList
- isNull
- like
- lte
- lt
- ne
- notInList
- notNull
- or
- type/ComparisonOperator
- sql/function
- rawSql
- sql
- type
- AdapterCapabilities
- AdapterCapabilityOverrides
- AdapterExecuteRequest
- AdapterResult
- AdapterStatement
- ColumnSchemas
- Predicate
- SqlStatement
- TransactionOptions
- TransactionToken
- WhereInput
- fetch-proxy
- function
- FetchProxy
- createFetchProxy
- interface/FetchProxyOptions
- fetch-router
- class
- AppStorage
- RequestContext
- function
- Middleware
- RequestHandler
- createRouter
- createStorageKey
- interface
- RouterOptions
- Router
- routes
- class/Route
- function
- createDeleteRoute
- createFormRoutes
- createGetRoute
- createHeadRoute
- createOptionsRoute
- createPatchRoute
- createPostRoute
- createPutRoute
- createResourceRoutes
- createResourcesRoutes
- createRoutes
- form
- resources
- resource
- route
- interface
- RouteDefs
- RouteMap
- type
- BuildRoute
- RouteDef
- type
- Action
- BuildAction
- NextFunction
- file-storage
- fs/function/createFsFileStorage
- interface
- FileKey
- FileMetadata
- FileStorage
- ListOptions
- ListResult
- memory/function/createMemoryFileStorage
- form-data-middleware
- class/FormDataParseError
- function
- FileUploadHandler
- formData
- interface
- FileUpload
- FormDataOptions
- form-data-parser
- class
- MaxFileSizeExceededError
- MaxFilesExceededError
- MaxHeaderSizeExceededError
- MultipartParseError
- function
- FileUploadHandler
- parseFormData
- interface/ParseFormDataOptions
- fs
- function
- openLazyFile
- writeFile
- interface/OpenLazyFileOptions
- headers
- class
- AcceptEncoding
- AcceptLanguage
- Accept
- CacheControl
- ContentDisposition
- ContentRange
- ContentType
- Cookie
- IfMatch
- IfNoneMatch
- IfRange
- Range
- SetCookie
- Vary
- function
- parse
- stringify
- interface
- CacheControlInit
- ContentDispositionInit
- ContentRangeInit
- ContentTypeInit
- CookieProperties
- IfMatchInit
- IfNoneMatchInit
- RangeInit
- SetCookieInit
- type
- AcceptEncodingInit
- AcceptInit
- AcceptLanguageInit
- CookieInit
- html-template
- function/isSafeHtml
- type/SafeHtml
- interaction
- class/TypedEventTarget
- function
- createContainer
- defineInteraction
- on
- interface/Interaction
- type
- ContainerOptions
- Dispatched
- EventListeners
- EventsContainer
- InteractionSetup
- lazy-file
- class
- LazyBlob
- LazyFile
- function
- getByteLength
- getIndexes
- interface
- ByteRange
- LazyBlobOptions
- LazyContent
- LazyFileOptions
- logger-middleware
- function/logger
- interface/LoggerOptions
- method-override-middleware
- function/methodOverride
- interface/MethodOverrideOptions
- mime/function
- defineMimeType
- detectContentType
- detectMimeType
- isCompressibleMimeType
- mimeTypeToContentType
- multipart-parser
- class
- MultipartParser
- MultipartPart
- function
- getMultipartBoundary
- isMultipartRequest
- parseMultipartRequest
- parseMultipartStream
- parseMultipart
- interface/ParseMultipartOptions
- node/function
- getMultipartBoundary
- isMultipartRequest
- parseMultipartRequest
- parseMultipartStream
- parseMultipart
- type/MultipartParserOptions
- node-fetch-server
- function
- ErrorHandler
- FetchHandler
- createHeaders
- createRequestListener
- createRequest
- sendResponse
- interface
- ClientAddress
- RequestListenerOptions
- type/RequestOptions
- response
- compress/function/compressResponse
- file
- function/createFileResponse
- interface/FileResponseOptions
- type/FileDigestFunction
- html/function/createHtmlResponse
- redirect/function/createRedirectResponse
- route-pattern
- class/RoutePattern
- specificity/function
- ascending
- compare
- descending
- equal
- greaterThan
- lessThan
- type
- Join
- Matcher
- Params
- session-middleware/function/session
- session
- class/Session
- cookie-storage/function/createCookieSessionStorage
- fs-storage/function/createFsSessionStorage
- function
- createSessionId
- createSession
- interface/SessionStorage
- memory-storage/function/createMemorySessionStorage
- static-middleware
- function/staticFiles
- interface/StaticFilesOptions
- tar-parser
- class
- TarEntry
- TarParseError
- TarParser
- function
- parseTarHeader
- parseTar
- interface
- ParseTarHeaderOptions
- TarHeader
- type
- ParseTarOptions
- TarParserOptions
- assets
- fragment/remix
- async-context-middleware/function
- asyncContext
- getContext
- component
- function
- clientEntry
- spring
- tween
- interface
- AnimateProp
- Context
- Handle
- LayoutAnimationConfig
- PresenceConfig
- PresenceKeyframeConfig
- PresenceKeyframe
- PresenceOptions
- jsx-dev-runtime
- interface/RemixElement
- type
- ElementProps
- ElementType
- Props
- RemixNode
- Renderable
- type
- EntryComponent
- FrameHandle
- PresenceStyleProperties
- SerializableArray
- SerializableObject
- SerializablePrimitive
- SerializableProps
- SerializableValue
- SpringPreset
- Task
- compression-middleware/function/compression
- cookie
- class/Cookie
- function/createCookie
- interface/CookieOptions
- data-schema
- checks/function
- email
- maxLength
- max
- minLength
- min
- url
- class/ValidationError
- coerce/function
- bigint
- boolean
- date
- number
- string
- function
- any
- array
- bigint
- boolean
- defaulted
- enum_
- instanceof_
- literal
- map
- null_
- nullable
- number
- object
- optional
- parseSafe
- parse
- record
- set
- string
- symbol
- tuple
- undefined_
- union
- variant
- lazy/function/lazy
- type
- Check
- ErrorMapContext
- ErrorMap
- InferInput
- InferOutput
- Issue
- ParseOptions
- Schema
- ValidationOptions
- ValidationResult
- data-table-mysql
- class/MysqlDatabaseAdapter
- function/createMysqlDatabaseAdapter
- type
- MysqlDatabaseAdapterOptions
- MysqlDatabaseConnection
- MysqlDatabasePool
- MysqlQueryResponse
- MysqlQueryResultHeader
- MysqlQueryRows
- data-table-postgres
- class/PostgresDatabaseAdapter
- function/createPostgresDatabaseAdapter
- type
- PostgresDatabaseAdapterOptions
- PostgresDatabaseClient
- PostgresDatabasePool
- PostgresQueryResult
- PostgresTransactionClient
- data-table-sqlite
- class/SqliteDatabaseAdapter
- function/createSqliteDatabaseAdapter
- type
- SqliteDatabaseAdapterOptions
- SqliteDatabaseConnection
- data-table
- class
- DataTableAdapterError
- DataTableConstraintError
- DataTableError
- DataTableQueryError
- DataTableValidationError
- QueryBuilder
- function
- and
- belongsTo
- between
- createDatabase
- createTable
- eq
- getTableColumns
- getTableName
- getTablePrimaryKey
- getTableReference
- getTableTimestamps
- gte
- gt
- hasManyThrough
- hasMany
- hasOne
- ilike
- inList
- isNull
- like
- lte
- lt
- ne
- notInList
- notNull
- or
- rawSql
- sql
- timestampSchema
- timestamps
- interface/DatabaseAdapter
- operators
- function
- and
- between
- eq
- gte
- gt
- ilike
- inList
- isNull
- like
- lte
- lt
- ne
- notInList
- notNull
- or
- type/ComparisonOperator
- sql/function
- rawSql
- sql
- type
- AdapterCapabilities
- AdapterCapabilityOverrides
- AdapterExecuteRequest
- AdapterResult
- AdapterStatement
- ColumnSchemas
- Predicate
- SqlStatement
- TransactionOptions
- TransactionToken
- WhereInput
- fetch-proxy
- function
- FetchProxy
- createFetchProxy
- interface/FetchProxyOptions
- fetch-router
- class
- AppStorage
- RequestContext
- function
- Middleware
- RequestHandler
- createRouter
- createStorageKey
- interface
- RouterOptions
- Router
- routes
- class/Route
- function
- createDeleteRoute
- createFormRoutes
- createGetRoute
- createHeadRoute
- createOptionsRoute
- createPatchRoute
- createPostRoute
- createPutRoute
- createResourceRoutes
- createResourcesRoutes
- createRoutes
- form
- resources
- resource
- route
- interface
- RouteDefs
- RouteMap
- type
- BuildRoute
- RouteDef
- type
- Action
- BuildAction
- NextFunction
- file-storage
- fs/function/createFsFileStorage
- interface
- FileKey
- FileMetadata
- FileStorage
- ListOptions
- ListResult
- memory/function/createMemoryFileStorage
- form-data-middleware
- class/FormDataParseError
- function
- FileUploadHandler
- formData
- interface
- FileUpload
- FormDataOptions
- form-data-parser
- class
- MaxFileSizeExceededError
- MaxFilesExceededError
- MaxHeaderSizeExceededError
- MultipartParseError
- function
- FileUploadHandler
- parseFormData
- interface/ParseFormDataOptions
- fs
- function
- openLazyFile
- writeFile
- interface/OpenLazyFileOptions
- headers
- class
- AcceptEncoding
- AcceptLanguage
- Accept
- CacheControl
- ContentDisposition
- ContentRange
- ContentType
- Cookie
- IfMatch
- IfNoneMatch
- IfRange
- Range
- SetCookie
- Vary
- function
- parse
- stringify
- interface
- CacheControlInit
- ContentDispositionInit
- ContentRangeInit
- ContentTypeInit
- CookieProperties
- IfMatchInit
- IfNoneMatchInit
- RangeInit
- SetCookieInit
- type
- AcceptEncodingInit
- AcceptInit
- AcceptLanguageInit
- CookieInit
- html-template
- function/isSafeHtml
- type/SafeHtml
- interaction
- class/TypedEventTarget
- function
- createContainer
- defineInteraction
- on
- interface/Interaction
- type
- ContainerOptions
- Dispatched
- EventListeners
- EventsContainer
- InteractionSetup
- lazy-file
- class
- LazyBlob
- LazyFile
- function
- getByteLength
- getIndexes
- interface
- ByteRange
- LazyBlobOptions
- LazyContent
- LazyFileOptions
- logger-middleware
- function/logger
- interface/LoggerOptions
- method-override-middleware
- function/methodOverride
- interface/MethodOverrideOptions
- mime/function
- defineMimeType
- detectContentType
- detectMimeType
- isCompressibleMimeType
- mimeTypeToContentType
- multipart-parser
- class
- MultipartParser
- MultipartPart
- function
- getMultipartBoundary
- isMultipartRequest
- parseMultipartRequest
- parseMultipartStream
- parseMultipart
- interface/ParseMultipartOptions
- node/function
- getMultipartBoundary
- isMultipartRequest
- parseMultipartRequest
- parseMultipartStream
- parseMultipart
- type/MultipartParserOptions
- node-fetch-server
- function
- ErrorHandler
- FetchHandler
- createHeaders
- createRequestListener
- createRequest
- sendResponse
- interface
- ClientAddress
- RequestListenerOptions
- type/RequestOptions
- response
- compress/function/compressResponse
- file
- function/createFileResponse
- interface/FileResponseOptions
- type/FileDigestFunction
- html/function/createHtmlResponse
- redirect/function/createRedirectResponse
- route-pattern
- class/RoutePattern
- specificity/function
- ascending
- compare
- descending
- equal
- greaterThan
- lessThan
- type
- Join
- Matcher
- Params
- session-middleware/function/session
- session
- class/Session
- cookie-storage/function/createCookieSessionStorage
- fs-storage/function/createFsSessionStorage
- function
- createSessionId
- createSession
- interface/SessionStorage
- memory-storage/function/createMemorySessionStorage
- static-middleware
- function/staticFiles
- interface/StaticFilesOptions
- tar-parser
- class
- TarEntry
- TarParseError
- TarParser
- function
- parseTarHeader
- parseTar
- interface
- ParseTarHeaderOptions
- TarHeader
- type
- ParseTarOptions
- TarParserOptions
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.
Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
0 commit comments