This repository is in a frozen state. It is not being maintained or kept in sync with the libraries it depends on. This library was designed for an early version of go-filecoin, which is now known as Venus. An API client for Lotus can be found at https://github.com/filecoin-shipyard/js-lotus-client-rpc that may be used to build similar functionality. Even though work on this repository has been shelved, anyone interested in updating or maintaining this library should express their interest on one Filecoin community conversation mediums: https://github.com/filecoin-project/community#join-the-community.
React hook to load config via Filecoin API
Uses js-filecoin-api-client to connect to the go-filecoin HTTP API running on localhost.
Note: Even though it is a React hook, it was built to be used in command-line apps that run in a Node.js environment, it has not yet been used in the browser.
From filecoin-big-head which uses React with Ink in a Node.js interactive command-line app:
import useFilecoinConfig from '@filecoin-shipyard/use-filecoin-config'
const Main = () => {
const [nickError, nickname] = useFilecoinConfig('heartbeat.nickname')
return <Box>{nickname && nickname}</Box>
}| Name | Type | Description |
|---|---|---|
| key | String |
Dot separated key to config value to retrieve |
| options | Object |
Optional options |
| options.interval | Number |
Requery the config value every interval milliseconds (Default: 1000) |
Returns an array of values, like other React hooks.
| Index | Type | Description |
|---|---|---|
| 0 | Error |
Error object or null |
| 1 | ? |
Value from config |
MIT/Apache-2 (Permissive License Stack)