@xmtp/content-type-text
v1.0.0
Published
An XMTP content type to support text messages
Downloads
11,532
Readme
Text content type
This package provides an XMTP content type to support text messages.
Install the package
# npm
npm i @xmtp/content-type-text
# yarn
yarn add @xmtp/content-type-text
# pnpm
pnpm i @xmtp/content-type-text
Send a text message
Use a string to send a text message. It's not required to specify a content type in the send options for text messages.
await conversation.send("gm");
Developing
Run yarn dev
to build the content type and watch for changes, which will trigger a rebuild.
Testing
Before running unit tests, start the required Docker container at the root of this repository. For more info, see Running tests.
Useful commands
yarn build
: Builds the content typeyarn clean
: Removesnode_modules
,dist
, and.turbo
foldersyarn dev
: Builds the content type and watches for changes, which will trigger a rebuildyarn format
: Runs prettier format and write changesyarn format:check
: Runs prettier format checkyarn lint
: Runs ESLintyarn test:setup
: Starts a necessary docker container for testingyarn test:teardown
: Stops docker container for testingyarn test
: Runs all unit testsyarn typecheck
: Runstsc