Skip to main content

14 posts tagged with "tutorial"

View All Tags

How can I validate my step inputs and outputs?

· 5 min read
Jeremy Scott
Co-founder

Version 3 of opscotch introduces a small but powerful "preprocessor" called doc for JavaScript processors. The doc functions allow you to add documentation and add programatic declarations of what inputs and outputs your step expects and returns. It's a way to validate and perform type checking, and also declares your expectations to callers.

See the doc documentation here

How can I upload binary files?

· One min read
Jeremy Scott
Co-founder

Prior to version 3.1.0 of opscotch, you could only receive text content from the HTTP trigger i.e. json or text like. Version 3.1.0 now lets workflows receive raw binary uploads. The new context.getStream() call gives you direct access to the byte stream.

Byte manipulation in workflows

· 3 min read
Jeremy Scott
Co-founder

Prior to version 3.1.0 of opscotch, payload manipulation was limited to text - you could manipulate that at the byte level in JavaScript but it was very cumbersome and inefficient.

Version 3.1.0 of opscotch adds a ByteContext plus a ByteReader for low-level byte manipulation inside workflows. This is for engineers who already think in buffers, encodings, and compression.

How can I process multipart HTTP uploads in workflows?

· 4 min read
Jeremy Scott
Co-founder

Version 3.1.0 of opscotch adds support for HTTP multipart uploads, letting you receive text/JSON and binary content in the same request. This unlocks use cases like “send me the metadata and the file in one hit,” without forcing you to pick one or chain requests. With saftey in mind - this is disabled by default.

How can I watch log file?

· 2 min read
Jeremy Scott
Co-founder

In opscotch version 3, file access was introduced, along with the fileWatcher step trigger. File watching is a capability that allows you to request the agent to call a step when a file is changed—for example, when a log file is updated, you can receive the new lines as a step payload. As security is always a top priority, file access is strictly controlled in several ways.

How can I use the internal queue?

· 2 min read
Jeremy Scott
Co-founder

An exciting change in version 3 of opscotch is the introduction of workflow-available high-performance persistent FIFO queues. This was the missing functionality that allows opscotch workflows to robustly buffer outbound data - essentially acting as a log aggregator, among other uses.