<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

### Table of Contents

-   [constructor][1]
-   [shutdown][2]
-   [startup][3]
-   [runMessage][4]
-   [incrementTicks][5]
-   [createActor][6]
-   [send][7]

## constructor

[actor.js:17-26][8]

the Actor manages the varous message passing functions and provides
an interface for the containers to use

**Parameters**

-   `opts` **[Object][9]** 
    -   `opts.id` **ID** the UUID of the Actor
    -   `opts.state` **[Object][9]** the state of the container
    -   `opts.storage` **[Object][9]** the actor's persistant storage
    -   `opts.hypervisor` **[Object][9]** the instance of the hypervisor
    -   `opts.nonce` **[Number][10]** 
    -   `opts.type` **[Number][10]** the container type
    -   `opts.container` **[Function][11]** the container constuctor and argments

## shutdown

[actor.js:31-35][12]

Runs the shutdown routine for the actor

## startup

[actor.js:40-42][13]

Runs the startup routine for the actor

## runMessage

[actor.js:50-61][14]

run the Actor with a given message

**Parameters**

-   `message` **[object][9]** the message to run
-   `method` **[String][15]** which method to run

Returns **[Promise][16]** 

## incrementTicks

[actor.js:67-73][17]

updates the number of ticks that the actor has run

**Parameters**

-   `count` **[Number][10]** the number of ticks to add

## createActor

[actor.js:80-83][18]

creates an actor

**Parameters**

-   `type` **Integer** the type id for the container
-   `code`  
-   `message` **[Object][9]** an intial [message][19] to send newly created actor

## send

[actor.js:100-105][20]

sends a message to a given port

**Parameters**

-   `message` **Message** the message
-   `portRef` **[Object][9]** the port

[1]: #constructor

[2]: #shutdown

[3]: #startup

[4]: #runmessage

[5]: #incrementticks

[6]: #createactor

[7]: #send

[8]: https://github.com/dfinity/js-primea/blob/1f8affb407f9413e9af400e3cc7408ece8274347/actor.js#L17-L26 "Source code on GitHub"

[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object

[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number

[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function

[12]: https://github.com/dfinity/js-primea/blob/1f8affb407f9413e9af400e3cc7408ece8274347/actor.js#L31-L35 "Source code on GitHub"

[13]: https://github.com/dfinity/js-primea/blob/1f8affb407f9413e9af400e3cc7408ece8274347/actor.js#L40-L42 "Source code on GitHub"

[14]: https://github.com/dfinity/js-primea/blob/1f8affb407f9413e9af400e3cc7408ece8274347/actor.js#L50-L61 "Source code on GitHub"

[15]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String

[16]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise

[17]: https://github.com/dfinity/js-primea/blob/1f8affb407f9413e9af400e3cc7408ece8274347/actor.js#L67-L73 "Source code on GitHub"

[18]: https://github.com/dfinity/js-primea/blob/1f8affb407f9413e9af400e3cc7408ece8274347/actor.js#L80-L83 "Source code on GitHub"

[19]: https://github.com/primea/js-primea-message

[20]: https://github.com/dfinity/js-primea/blob/1f8affb407f9413e9af400e3cc7408ece8274347/actor.js#L100-L105 "Source code on GitHub"