@php-wasm/web

Index

Classes

• FirewallInterferenceError

Functions

• certificateToPEM
• createDirectoryHandleMountHandler
• fetchWithCorsProxy
• generateCertificate
• getPHPLoaderModule
• loadWebRuntime
• privateKeyToPEM
• setupPostMessageRelay
• spawnPHPWorkerThread

Interfaces

• BasicConstraints
• DirectoryHandleMount
• DistinguishedName
• ExtKeyUsage
• KeyUsage
• MountOptions
• NSCertType
• PHPWebLoaderOptions
• SubjectAltNames
• TBSCertificateDescription

References

• PublicAPI
• RemoteAPI
• WithAPIState
• WithIsReady
• exposeAPI

Type Aliases

• BuiltInPHPWebExtensionName
• GeneratedCertificate
• MountDevice
• OID
• OIDName
• PHPWebExtension
• RuntimePHPWebExtensionSource
• SyncProgress
• SyncProgressCallback
• TBSCertificate
• TCPOverFetchOptions
• Validity

Variables

• consumeAPI

References

PublicAPI

Renames and re-exports consumeAPI

RemoteAPI

Renames and re-exports consumeAPI

WithAPIState

Renames and re-exports consumeAPI

WithIsReady

Renames and re-exports consumeAPI

exposeAPI

Renames and re-exports consumeAPI

Type Aliases

BuiltInPHPWebExtensionName

BuiltInPHPWebExtensionName: intl

Built-in PHP extensions shipped with @php-wasm/web.

GeneratedCertificate

GeneratedCertificate: { certificate: Uint8Array; keyPair: CryptoKeyPair; tbsCertificate: TBSCertificate; tbsDescription: TBSCertificateDescription }

Type declaration

• certificate: Uint8Array

• keyPair: CryptoKeyPair

• tbsCertificate: TBSCertificate

• tbsDescription: TBSCertificateDescription

MountDevice

MountDevice: { path: string; type: opfs } | { handle: FileSystemDirectoryHandle; type: local-fs }

OID

OID: keyof typeof oids

OIDName

OIDName: typeof oids[OID]

PHPWebExtension

PHPWebExtension: BuiltInPHPWebExtensionName | { name: BuiltInPHPWebExtensionName } | RuntimePHPWebExtensionSource

PHP extension request accepted by loadWebRuntime().

The array may mix built-in extension names with external extension sources:

await loadWebRuntime('8.4', {
  extensions: [
    'intl',
    { source: { format: 'manifest', manifestUrl } },
  ],
});

RuntimePHPWebExtensionSource

RuntimePHPWebExtensionSource: Omit<ResolvedInstallOptions, phpVersion>

External PHP extension source that can be installed before PHP starts.

External sources are supported in JSPI runtimes only. Asyncify support is limited to bundled extensions shipped with this package.

SyncProgress

SyncProgress: { files: number; total: number }

Type declaration

• files: number

  The number of files that have been synced.

• total: number

  The number of all files that need to be synced.

SyncProgressCallback

SyncProgressCallback: (progress: SyncProgress) => void

Type declaration

• • (progress: SyncProgress): void

  • Parameters

    • progress: SyncProgress

    Returns void

TBSCertificate

TBSCertificate: Uint8Array

TCPOverFetchOptions

TCPOverFetchOptions: { CAroot: GeneratedCertificate; corsProxyUrl?: string }

Type declaration

• CAroot: GeneratedCertificate

• optionalcorsProxyUrl?: string

Validity

Validity: { notAfter: Date; notBefore: Date }

Type declaration

• notAfter: Date

• notBefore: Date

Variables

consumeAPI

consumeAPI: any