@php-wasm/web

Index

Functions

• certificateToPEM
• consumeAPI
• createDirectoryHandleMountHandler
• exposeAPI
• generateCertificate
• getPHPLoaderModule
• loadWebRuntime
• privateKeyToPEM
• setupPostMessageRelay
• spawnPHPWorkerThread

Interfaces

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

References

• WithAPIState

Type Aliases

• GeneratedCertificate
• MountDevice
• OID
• OIDName
• PublicAPI
• RemoteAPI
• SyncProgress
• SyncProgressCallback
• TBSCertificate
• TCPOverFetchOptions
• Validity
• WithIsReady

References

WithAPIState

Renames and re-exports WithIsReady

Type Aliases

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]

PublicAPI

PublicAPI<Methods, PipedAPI>: RemoteAPI<Methods & PipedAPI>

Type parameters

• Methods
• PipedAPI = unknown

RemoteAPI

RemoteAPI<T>: Comlink.Remote<T> & WithAPIState

Type parameters

• T

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 }

Type declaration

• CAroot: GeneratedCertificate

Validity

Validity: { notAfter: Date; notBefore: Date }

Type declaration

• notAfter: Date

• notBefore: Date

WithIsReady

WithIsReady: { isConnected: () => Promise<void>; isReady: () => Promise<void> }

Type declaration

• isConnected: () => Promise<void>

  • • (): Promise<void>

    • Resolves to true when the remote API is ready for Comlink communication, but not necessarily fully initialized yet.

      ---

      Returns Promise<void>

• isReady: () => Promise<void>

  • • (): Promise<void>

    • Resolves to true when the remote API is declares it’s fully loaded and ready to be used.

      ---

      Returns Promise<void>