Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add ActorLogic interface docs #4445

Merged
merged 2 commits into from
Nov 13, 2023
Merged

Add ActorLogic interface docs #4445

merged 2 commits into from
Nov 13, 2023

Conversation

audionerd
Copy link
Contributor

While working on docs for "Custom actor logic" I felt it would be helpful to have the ActorLogic interface better documented.

Related to statelyai/docs#252

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Nov 9, 2023 •
edited
Loading

⚠️ No Changeset found

Latest commit: ddf0635

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@codesandbox-ci CodeSandbox CI
Copy link

codesandbox-ci bot commented Nov 9, 2023 •
edited
Loading

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit ddf0635:

Sandbox Source
XState Example Template Configuration
XState React Template Configuration

audionerd
audionerd commented Nov 9, 2023
View reviewed changes
packages/core/src/types.ts
export interface ActorLogic<
TSnapshot extends Snapshot<unknown>,
TEvent extends EventObject,
TInput = unknown,
TSystem extends ActorSystem<any> = ActorSystem<any>
> {
/** Optional configuration for the actor logic. */
config?: unknown;
Copy link
Contributor Author

@audionerd audionerd Nov 9, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could use a better comment here re: why/how config is used. I wasn't sure what to write here.

@davidkpiano davidkpiano merged commit c50b4ea into statelyai:next Nov 13, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@davidkpiano davidkpiano davidkpiano approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@audionerd @davidkpiano