PHP's file_get_contents in TypeScript

How to use

Install via yarn add locutus and import: import { file_get_contents } from 'locutus/php/filesystem/file_get_contents'.

Or with CommonJS: const { file_get_contents } = require('locutus/php/filesystem/file_get_contents')

Use a bundler that supports tree-shaking so you only ship the functions you actually use. Vite, webpack, Rollup, and Parcel all handle this. For server-side use this is less of a concern.

Examples

These examples are extracted from test cases that automatically verify our functions against their native counterparts.

#	code	expected result
1	var $buf = file_get_contents('test/never-change.txt') var $result = $buf.indexOf('hash') !== -1	true

Notes

• This used to work in the browser via blocking ajax requests in 1.3.2 and earlier but then people started using that for real app, so we deprecated this behavior, so this function is now Node-only

Here's what our current TypeScript equivalent to PHP's file_get_contents looks like.

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

import fs from 'fs'
import type { PhpRuntimeValue } from '../_helpers/_phpTypes.ts'

type FileGetContentsInput = PhpRuntimeValue

export function file_get_contents(
  url: string,
  _flags?: FileGetContentsInput,
  _context?: FileGetContentsInput,
  _offset?: number,
  _maxLen?: number,
): string | false {
  //       discuss at: https://locutus.io/php/file_get_contents/
  //      original by: Legaev Andrey
  //         input by: Jani Hartikainen
  //         input by: Raphael (Ao) RUDLER
  //      improved by: Kevin van Zonneveld (https://kvz.io)
  //      improved by: Brett Zamir (https://brett-zamir.me)
  //      bugfixed by: Brett Zamir (https://brett-zamir.me)
  // reimplemented by: Kevin van Zonneveld (https://kvz.io)
  //           note 1: This used to work in the browser via blocking ajax
  //           note 1: requests in 1.3.2 and earlier
  //           note 1: but then people started using that for real app,
  //           note 1: so we deprecated this behavior,
  //           note 1: so this function is now Node-only
  //        example 1: var $buf = file_get_contents('test/never-change.txt')
  //        example 1: var $result = $buf.indexOf('hash') !== -1
  //        returns 1: true

  return fs.readFileSync(url, 'utf-8')
}

import fs from 'fs'

export function file_get_contents(url, _flags, _context, _offset, _maxLen) {
  //       discuss at: https://locutus.io/php/file_get_contents/
  //      original by: Legaev Andrey
  //         input by: Jani Hartikainen
  //         input by: Raphael (Ao) RUDLER
  //      improved by: Kevin van Zonneveld (https://kvz.io)
  //      improved by: Brett Zamir (https://brett-zamir.me)
  //      bugfixed by: Brett Zamir (https://brett-zamir.me)
  // reimplemented by: Kevin van Zonneveld (https://kvz.io)
  //           note 1: This used to work in the browser via blocking ajax
  //           note 1: requests in 1.3.2 and earlier
  //           note 1: but then people started using that for real app,
  //           note 1: so we deprecated this behavior,
  //           note 1: so this function is now Node-only
  //        example 1: var $buf = file_get_contents('test/never-change.txt')
  //        example 1: var $result = $buf.indexOf('hash') !== -1
  //        returns 1: true

  return fs.readFileSync(url, 'utf-8')
}

Improve this function

Locutus is a community effort following The McDonald's Theory: we ship first iterations, hoping others will improve them. If you see something that could be better, we'd love your contribution.

View on GitHub · Edit on GitHub · View Raw

---

« More PHP filesystem functions

Star