Files
bitburner-src/markdown/bitburner.ns.read.md
Michael Taylor dcd2f33f7c CODEBASE: Update api-documentor and api-extractor (#2320)
* Update api-documentor and api-extractor. #1566 follow-up.

I have verified that the HTML/markdown table generation bug in
[#4878](https://github.com/microsoft/rushstack/issues/4878) in rushstack
for api-documentor has been fixed as per rushstack#5256. The testcase
[repro](https://github.com/catloversg/api-documenter-bug-pr-4578) now
produces the correct expected output.

I have confirmed that the generated output in bitburner from
`npm run doc` now generated HTML tables, and correctly inserts
a blank line between the </table> and the follow line (e.g. Returns).

Stylisticly it could use some whitespace, but it is correctly rendered.

This commit is only the updated packages, not the updated generated
documentation. I assume that is automatically generated by the GitHub
workflow.

* Follow up to 5f732a6f35, include `npm run doc` changed docs.

* Add missing license info

* Fix React warning

---------

Co-authored-by: CatLover <152669316+catloversg@users.noreply.github.com>
2025-09-26 14:52:39 -07:00

851 B

Home > bitburner > NS > read

NS.read() method

Read content of a file.

Signature:

read(filename: string): string;

Parameters

Parameter

Type

Description

filename

string

Name of the file to be read.

Returns:

string

Data in the specified text file.

Remarks

RAM cost: 0 GB

This function is used to read data from a text file (.txt, .json) or script (.js, .jsx, .ts, .tsx).

This function will return the data in the specified file. If the file does not exist, an empty string will be returned.