https://github.com/jcbhmr/go-tempy
📂 The tempy npm package ported to Go
https://github.com/jcbhmr/go-tempy
go golang port temporary-files tempy tmpdir
Last synced: 4 months ago
JSON representation
📂 The tempy npm package ported to Go
- Host: GitHub
- URL: https://github.com/jcbhmr/go-tempy
- Owner: jcbhmr
- License: mit
- Created: 2025-01-28T03:40:26.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-30T01:40:49.000Z (about 1 year ago)
- Last Synced: 2025-06-13T11:58:05.481Z (8 months ago)
- Topics: go, golang, port, temporary-files, tempy, tmpdir
- Language: Go
- Homepage: https://pkg.go.dev/github.com/jcbhmr/go-tempy/v3
- Size: 28.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tempy for Go
📂 The [tempy npm package](https://www.npmjs.com/package/tempy) ported to Go
```go
fmt.Println(tempy.TemporaryFile(&tempy.FileOptions{Extension: "png"}))
// Possible output: /tmp/a1b2c3d4a1b2c3d4a1b2c3d4a1b2c3d4.png
```
```go
p, err = tempy.TemporaryDirectory(&tempy.DirectoryOptions{Prefix: "name_"})
if err != nil {
log.Fatal(err)
}
log.Println(p)
// Possible output: /tmp/name_a1b2c3d4a1b2c3d4a1b2c3d4a1b2c3d4
```
🔗 Properly resolves `TMPDIR=/dirsymlink` symlinks \
🐿️ Uses Go idioms while maintaining the same API surface as tempy \
📁 Great for quickly writing some data to a temporary file
## Installation
```sh
go get github.com/jcbhmr/go-tempy/v3
```
## Usage
```go
package main
import (
"fmt"
"github.com/jcbhmr/go-tempy/v3"
)
func main() {
log.Println(tempy.TemporaryFile(nil))
log.Println(tempy.TemporaryFile(&tempy.FileOptions{Extension: "png"}))
log.Println(tempy.TemporaryFile(&tempy.FileOptions{Name: "unicorn.png"}))
p, err = tempy.TemporaryDirectory(nil)
if err != nil {
log.Fatal(err)
}
log.Println(p)
p, err = tempy.TemporaryDirectory(&tempy.DirectoryOptions{Prefix: "name_"})
if err != nil {
log.Fatal(err)
}
log.Println(p)
// Possible output:
// /tmp/a1b2c3d4a1b2c3d4a1b2c3d4a1b2c3d4
// /tmp/a1b2c3d4a1b2c3d4a1b2c3d4a1b2c3d4.png
// /tmp/unicorn.png
// /tmp/a1b2c3d4a1b2c3d4a1b2c3d4a1b2c3d4
// /tmp/name_a1b2c3d4a1b2c3d4a1b2c3d4a1b2c3d4
}
```
[📚 See pkg.go.dev/github.com/jcbhmr/go-tempy/v3 for more docs](https://pkg.go.dev/github.com/jcbhmr/go-tempy/v3)
## Development
This package attempts to mirror the functionality and API surface of [the tempy npm package](https://www.npmjs.com/package/tempy). To that end, we need to convert some JavaScript concepts to Go concepts.
- Union types like `TypedArray | Buffer` are mapped to `any` with a `switch x.(type)` or `if v, ok := x.(T); ok`. Doc comments should be included to clarify possible types.
- If possible, JavaScript standard library or Node.js standard library types are mapped to Go standard library types.
- Node.js `Buffer` is `[]byte`. `bytes.Buffer` might seem like a good fit but it implements `Reader` and `Writer` interfaces which we don't want.
- `ArrayBuffer` is `[]byte`. `bytes.Buffer` offers too much functionality.
- ECMA `TypedArray` variants are `[]`. Note that `byte` is an alias of `uint8`.
- ECMA `DataView` is `[]byte`. Byte slices can be views into other byte slices so this works OK.
- Node.js R/W streams are `io.(Read|Write)Closer` interfaces. Node.js streams are closed by the stream's consumer. We do the same here.
- All `Promise` values are flattened to just `T`. We let the user spawn goroutines if they want things to be asynchronous.
Also try to keep the version tags in sync. v1.0.0 of tempy on npm should correspond with v1.0.0 of this module.