Usage
Signature
Result
| Property | Type | Description |
|---|---|---|
| status | HandshakeStatus | A string indicating the status of the handshake between Replit and the Extension |
| error | string | null | If the handshake has failed, error is a string indicating the error message |
| filePath | string | null | If the handshake has succeeded, filePath points to the current file the user is focusing |
| replit | typeof replit | If the handshake has succeeded, replit is the API wrapper for the entire @replit/extensions module |
Types
HandshakeStatus
An enumerated set of values for the handshake status.| Key | Value |
|---|---|
| Ready | "ready" |
| Error | "error" |
| Loading | "loading" |
UseReplitReady
If the handshake between Replit and the Extension has been established successfully| Property | Type |
|---|---|
| status | HandshakeStatus.Ready |
| error | null |
| filePath | string |
| replit | typeof replit |
UseReplitLoading
The default handshake status, before initialization has been established.| Property | Type |
|---|---|
| status | HandshakeStatus.Loading |
| error | null |
| filePath | null |
| replit | null |
UseReplitFailure
If the handshake has failed.| Property | Type |
|---|---|
| status | HandshakeStatus.Error |
| error | string |
| filePath | null |
| replit | null |