@salesforce/b2c-tooling-sdk 1.19.1 → 1.20.1

package/data/script-api/dw.io.FileReader.md

@@ -1,70 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class FileReader
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.io.Reader](dw.io.Reader.md)
-    - [dw.io.FileReader](dw.io.FileReader.md)
-
-File reader class.
-
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [FileReader](#filereaderfile)([File](dw.io.File.md)) | Constructs the reader. |
-| [FileReader](#filereaderfile-string)([File](dw.io.File.md), [String](TopLevel.String.md)) | Constructs the reader. |
-
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [close](dw.io.FileReader.md#close)() | Closes the reader. |
-
-### Methods inherited from class Reader
-
-[close](dw.io.Reader.md#close), [getLines](dw.io.Reader.md#getlines), [getString](dw.io.Reader.md#getstring), [read](dw.io.Reader.md#read), [read](dw.io.Reader.md#readnumber), [readLine](dw.io.Reader.md#readline), [readLines](dw.io.Reader.md#readlines), [readN](dw.io.Reader.md#readnnumber), [readString](dw.io.Reader.md#readstring), [ready](dw.io.Reader.md#ready), [skip](dw.io.Reader.md#skipnumber)
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-## Constructor Details
-
-### FileReader(File)
-- FileReader(file: [File](dw.io.File.md))
-  - : Constructs the reader.
-      
-      
-      To release system resources, close the reader by calling [close()](dw.io.FileReader.md#close).
-
-
-    **Parameters:**
-    - file - the file object to read.
-
-
----
-
-### FileReader(File, String)
-- FileReader(file: [File](dw.io.File.md), encoding: [String](TopLevel.String.md))
-  - : Constructs the reader.
-      
-      
-      To release system resources, close the reader by calling [close()](dw.io.FileReader.md#close).
-
-
-    **Parameters:**
-    - file - the file object to read.
-    - encoding - the character encoding to use.
-
-
----
-
-## Method Details
-
-### close()
-- close(): void
-  - : Closes the reader.
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.io.FileWriter.md

@@ -1,159 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class FileWriter
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.io.Writer](dw.io.Writer.md)
-    - [dw.io.FileWriter](dw.io.FileWriter.md)
-
-Convenience class for writing character files.
-
-
-Files are stored in a shared file system where multiple processes could
-access the same file. The client code is responsible for ensuring that no
-more than one process writes to a file at a given time.
-
-
-**Note:** when this class is used with sensitive data, be careful in persisting sensitive information to disk.
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [lineSeparator](#lineseparator): [String](TopLevel.String.md) | Get the current line separator (e.g. |
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [FileWriter](#filewriterfile)([File](dw.io.File.md)) | Constructs the writer for the specified file. |
-| [FileWriter](#filewriterfile-boolean)([File](dw.io.File.md), [Boolean](TopLevel.Boolean.md)) | Constructs the writer for the specified file. |
-| [FileWriter](#filewriterfile-string)([File](dw.io.File.md), [String](TopLevel.String.md)) | Constructs the writer for the specified file with the specified encoding. |
-| [FileWriter](#filewriterfile-string-boolean)([File](dw.io.File.md), [String](TopLevel.String.md), [Boolean](TopLevel.Boolean.md)) | Constructs the writer for the specified file with the specified encoding. |
-
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [close](dw.io.FileWriter.md#close)() | Closes the writer. |
-| [getLineSeparator](dw.io.FileWriter.md#getlineseparator)() | Get the current line separator (e.g. |
-| [setLineSeparator](dw.io.FileWriter.md#setlineseparatorstring)([String](TopLevel.String.md)) | Set the line separator (e.g. |
-| [writeLine](dw.io.FileWriter.md#writelinestring)([String](TopLevel.String.md)) | Writes the specified line and appends the line separator. |
-
-### Methods inherited from class Writer
-
-[close](dw.io.Writer.md#close), [flush](dw.io.Writer.md#flush), [write](dw.io.Writer.md#writestring), [write](dw.io.Writer.md#writestring-number-number)
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-## Property Details
-
-### lineSeparator
-- lineSeparator: [String](TopLevel.String.md)
-  - : Get the current line separator (e.g. '\n' or '\r\n'), if no value is set the system default '\n' will be used.
-
-
----
-
-## Constructor Details
-
-### FileWriter(File)
-- FileWriter(file: [File](dw.io.File.md))
-  - : Constructs the writer for the specified file. Uses "UTF-8" as encoding.
-      
-      
-      To release system resources, close the writer by calling [close()](dw.io.FileWriter.md#close).
-
-
-    **Parameters:**
-    - file - the file object to write to.
-
-
----
-
-### FileWriter(File, Boolean)
-- FileWriter(file: [File](dw.io.File.md), append: [Boolean](TopLevel.Boolean.md))
-  - : Constructs the writer for the specified file. Optional file append mode
-      is supported. Uses "UTF-8" as encoding.
-      
-      
-      To release system resources, close the writer by calling [close()](dw.io.FileWriter.md#close).
-
-
-    **Parameters:**
-    - file - the file object to write to.
-    - append - flag, whether the file should be written in append mode
-
-
----
-
-### FileWriter(File, String)
-- FileWriter(file: [File](dw.io.File.md), encoding: [String](TopLevel.String.md))
-  - : Constructs the writer for the specified file with the specified encoding.
-      
-      
-      To release system resources, close the writer by calling [close()](dw.io.FileWriter.md#close).
-
-
-    **Parameters:**
-    - file - the file object to write to.
-    - encoding - the character encoding to use.
-
-
----
-
-### FileWriter(File, String, Boolean)
-- FileWriter(file: [File](dw.io.File.md), encoding: [String](TopLevel.String.md), append: [Boolean](TopLevel.Boolean.md))
-  - : Constructs the writer for the specified file with the specified encoding.
-      Optional file append mode is supported.
-      
-      
-      To release system resources, close the writer by calling [close()](dw.io.FileWriter.md#close).
-
-
-    **Parameters:**
-    - file - the file object to write to.
-    - encoding - the character encoding to use.
-    - append - flag indicating whether the file should be written in append mode.
-
-
----
-
-## Method Details
-
-### close()
-- close(): void
-  - : Closes the writer.
-
-
----
-
-### getLineSeparator()
-- getLineSeparator(): [String](TopLevel.String.md)
-  - : Get the current line separator (e.g. '\n' or '\r\n'), if no value is set the system default '\n' will be used.
-
-
----
-
-### setLineSeparator(String)
-- setLineSeparator(lineSeparator: [String](TopLevel.String.md)): void
-  - : Set the line separator (e.g. '\n' or '\r\n'), if no value is set the system default '\n' will be used.
-
-    **Parameters:**
-    - lineSeparator - that will be written at the end of each line
-
-
----
-
-### writeLine(String)
-- writeLine(str: [String](TopLevel.String.md)): void
-  - : Writes the specified line and appends the line separator.
-
-    **Parameters:**
-    - str - the line to write to the file.
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.io.InputStream.md

@@ -1,35 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class InputStream
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.io.InputStream](dw.io.InputStream.md)
-
-The class represent a stream of bytes that can be read from the
-application. The InputStream itself doesn't provide any methods
-to read the data. Instead the InputStream can be chained with
-other classes like a XMLStreamReader to read data.
-
-
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [close](dw.io.InputStream.md#close)() | Closes the input stream. |
-
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-## Method Details
-
-### close()
-- close(): void
-  - : Closes the input stream.
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.io.OutputStream.md

@@ -1,38 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class OutputStream
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.io.OutputStream](dw.io.OutputStream.md)
-
-The class represent a stream of bytes that can be written from the
-application. The OutputStream itself doesn't provide any methods
-to write the data. Instead the OutputStream can be chained with
-other classes like a XMLStreamWriter to write data.
-
-
-**Note:** when this class is used with sensitive data, be careful in persisting sensitive information to disk.
-
-
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [close](dw.io.OutputStream.md#close)() | Closes the output stream. |
-
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-## Method Details
-
-### close()
-- close(): void
-  - : Closes the output stream.
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.io.PrintWriter.md

@@ -1,66 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class PrintWriter
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.io.Writer](dw.io.Writer.md)
-    - [dw.io.PrintWriter](dw.io.PrintWriter.md)
-
-Template output stream writer.
-
-Printwriter is available in the template scripting context and is used
-to write data into the template output stream. You cannot instantiate this class
-directly. Instead, the system assigns the object to variable named 'out' in the script context
-to be used by the template scripts.
-
-
-**Note:** when this class is used with sensitive data, be careful in persisting sensitive information to disk.
-
-
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [print](dw.io.PrintWriter.md#printstring)([String](TopLevel.String.md)) | Prints the given string into the output stream. |
-| [println](dw.io.PrintWriter.md#println)() | Prints a line break into the output stream. |
-| [println](dw.io.PrintWriter.md#printlnstring)([String](TopLevel.String.md)) | Print the given string followed by a line break into the output stream. |
-
-### Methods inherited from class Writer
-
-[close](dw.io.Writer.md#close), [flush](dw.io.Writer.md#flush), [write](dw.io.Writer.md#writestring), [write](dw.io.Writer.md#writestring-number-number)
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-## Method Details
-
-### print(String)
-- print(str: [String](TopLevel.String.md)): void
-  - : Prints the given string into the output stream.
-
-    **Parameters:**
-    - str - the String object
-
-
----
-
-### println()
-- println(): void
-  - : Prints a line break into the output stream.
-
-
----
-
-### println(String)
-- println(str: [String](TopLevel.String.md)): void
-  - : Print the given string followed by a line break into the output stream.
-
-    **Parameters:**
-    - str - the String object
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.io.RandomAccessFileReader.md

@@ -1,183 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class RandomAccessFileReader
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.io.RandomAccessFileReader](dw.io.RandomAccessFileReader.md)
-
-Instances of this class support reading from a random access file. A random
-access file behaves like a large array of bytes stored in the file system.
-There is a kind of cursor, or index into the implied array, called the file
-pointer. Read operations read bytes starting at the file pointer and advance
-the file pointer past the bytes read. The file pointer can be read by the
-getPosition method and set by the setPosition method.
-
-
-
-## Constant Summary
-
-| Constant | Description |
-| --- | --- |
-| [MAX_READ_BYTES](#max_read_bytes): [Number](TopLevel.Number.md) = 10240 | The maximum number of bytes that a single call to [readBytes(Number)](dw.io.RandomAccessFileReader.md#readbytesnumber) can return == 10KB |
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [position](#position): [Number](TopLevel.Number.md) | Returns the current offset in this file. |
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [RandomAccessFileReader](#randomaccessfilereaderfile)([File](dw.io.File.md)) | Construct a reader for random read access to the provided file. |
-
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [close](dw.io.RandomAccessFileReader.md#close)() | Closes this random access file reader and releases any system resources  associated with the stream. |
-| [getPosition](dw.io.RandomAccessFileReader.md#getposition)() | Returns the current offset in this file. |
-| [length](dw.io.RandomAccessFileReader.md#length)() | Returns the length of this file. |
-| [readByte](dw.io.RandomAccessFileReader.md#readbyte)() | Reads a signed eight-bit value from the file starting from the current  file pointer. |
-| [readBytes](dw.io.RandomAccessFileReader.md#readbytesnumber)([Number](TopLevel.Number.md)) | Reads up to n bytes from the file starting at the current file pointer. |
-| [setPosition](dw.io.RandomAccessFileReader.md#setpositionnumber)([Number](TopLevel.Number.md)) | Sets the file-pointer offset, measured from the beginning of this file,  at which the next read occurs. |
-
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-## Constant Details
-
-### MAX_READ_BYTES
-
-- MAX_READ_BYTES: [Number](TopLevel.Number.md) = 10240
-  - : The maximum number of bytes that a single call to [readBytes(Number)](dw.io.RandomAccessFileReader.md#readbytesnumber) can return == 10KB
-
-
----
-
-## Property Details
-
-### position
-- position: [Number](TopLevel.Number.md)
-  - : Returns the current offset in this file.
-
-
----
-
-## Constructor Details
-
-### RandomAccessFileReader(File)
-- RandomAccessFileReader(file: [File](dw.io.File.md))
-  - : Construct a reader for random read access to the provided file.
-      
-      
-      To release system resources, close the reader by calling [close()](dw.io.RandomAccessFileReader.md#close).
-
-
-    **Parameters:**
-    - file - The file to be read. Must not be null.
-
-    **Throws:**
-    - IOException - If the given file object does not denote an existing              regular file
-
-
----
-
-## Method Details
-
-### close()
-- close(): void
-  - : Closes this random access file reader and releases any system resources
-      associated with the stream.
-
-
-    **Throws:**
-    - IOException - if an I/O error occurs.
-
-
----
-
-### getPosition()
-- getPosition(): [Number](TopLevel.Number.md)
-  - : Returns the current offset in this file.
-
-    **Returns:**
-    - the offset from the beginning of the file, in bytes, at which the
-              next read occurs.
-
-
-    **Throws:**
-    - IOException - if an I/O error occurs.
-
-
----
-
-### length()
-- length(): [Number](TopLevel.Number.md)
-  - : Returns the length of this file.
-
-    **Returns:**
-    - the length of this file, measured in bytes.
-
-    **Throws:**
-    - IOException - if an I/O error occurs.
-
-
----
-
-### readByte()
-- readByte(): [Number](TopLevel.Number.md)
-  - : Reads a signed eight-bit value from the file starting from the current
-      file pointer. Since the byte is interpreted as signed, the value returned
-      will always be between -128 and +127.
-
-
-    **Returns:**
-    - the next byte of this file as a signed eight-bit byte.
-
-    **Throws:**
-    - IOException - if an I/O error occurs or if this file has reached              the end.
-
-
----
-
-### readBytes(Number)
-- readBytes(numBytes: [Number](TopLevel.Number.md)): [Bytes](dw.util.Bytes.md)
-  - : Reads up to n bytes from the file starting at the current file pointer.
-      If there are fewer than n bytes remaining in the file, then as many bytes
-      as possible are read. If no bytes remain in the file, then null is
-      returned.
-
-
-    **Parameters:**
-    - numBytes - The number of bytes to read. Must be non-negative and             smaller than [MAX_READ_BYTES](dw.io.RandomAccessFileReader.md#max_read_bytes) or an exception             will be thrown.
-
-    **Returns:**
-    - A Bytes object representing the read bytes or null if no bytes
-              were read.
-
-
-    **Throws:**
-    - IOException - if an I/O error occurs.
-    - IllegalArgumentException - if numBytes< 0 or numBytes > MAX\_READ\_BYTES.
-
-
----
-
-### setPosition(Number)
-- setPosition(position: [Number](TopLevel.Number.md)): void
-  - : Sets the file-pointer offset, measured from the beginning of this file,
-      at which the next read occurs. The offset may be set beyond the end of
-      the file.
-
-
-    **Parameters:**
-    - position - the offset position, measured in bytes from the beginning             of the file, at which to set the file pointer
-
-    **Throws:**
-    - IOException - if position is less than 0 or if an I/O error occurs.
-
-
----
-
-<!-- prettier-ignore-end -->