`useReplit()` Hook

The useReplit() hook establishes the handshake between the Replit and the extension and passes the API wrapper for usage inside a React component.

Usage

import { useReplit } from '@replit/extensions-react';

const Component = () => {
  const { replit, status, filePath, error } = useReplit();

  ...
}

function useReplit(init?: {
  permissions: Array<string>;
}): UseReplitInitialized | UseReplitPreInitialization | UseReplitFailure;

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

An enumerated set of values for the handshake status.

If the handshake between Replit and the Extension has been established successfully

The default handshake status, before initialization has been established.

If the handshake has failed.