Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nedpals/v-mime
MIME Library for V.
https://github.com/nedpals/v-mime
mime mime-types v vlang
Last synced: 9 days ago
JSON representation
MIME Library for V.
- Host: GitHub
- URL: https://github.com/nedpals/v-mime
- Owner: nedpals
- License: mit
- Created: 2019-07-19T11:36:36.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-12-28T14:22:10.000Z (about 5 years ago)
- Last Synced: 2024-11-05T10:13:36.117Z (about 2 months ago)
- Topics: mime, mime-types, v, vlang
- Language: V
- Size: 54.7 KB
- Stars: 24
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-v - v-mime - MIME detection library for V. (Libraries / File handling)
README
# V-MIME 0.1
MIME library for the [V Programming Language](https://github.com/vlang/v). Inspired from the [mime-types](https://github.com/jshttp/mime-types) JS library.
What does it do? It dentifies the MIME/data types of a file like `application/json`.
## Usage
```golang
import mime
// As a workaround, alias the `MimeType` type
type MimeType mime.MimeType
fn main() {
mime_db := mime.load()
filepath := './app.json'
filetype := mime_db.lookup(filepath)
println(filetype) // application/json
}
```
## API
### mime.lookup(path string)
Lookup the content-type associated with a file.
```golang
mime_db.lookup('json') // 'application/json'
mime_db.lookup('.md') // 'text/markdown'
mime_db.lookup('file.html') // 'text/html'
mime_db.lookup('folder/file.js') // 'application/javascript'
mime_db.lookup('folder/.htaccess') // ''
mime_db.lookup('cats') // ''
```
### mime.content_type(type string)
Create a full content-type header given a content-type or extension.
When given an extension, `mime_db.lookup` is used to get the matching
content-type, otherwise the given content-type is used. Then if the
content-type does not already have a `charset` parameter, `mime_db.charset`
is used to get the default charset and add to the returned content-type.
```golang
mime_db.content_type('markdown') // 'text/x-markdown; charset=utf-8'
mime_db.content_type('file.json') // 'application/json; charset=utf-8'
mime_db.content_type('text/html') // 'text/html; charset=utf-8'
mime_db.content_type('text/html; charset=iso-8859-1') // 'text/html; charset=iso-8859-1'
// from a full path
mime_db.content_type(os.ext('/path/to/file.json')) // 'application/json; charset=utf-8'
```
### mime.extension(type string)
Get the default extension for a content-type.
```golang
mime_db.extension('application/octet-stream') // 'bin'
```
### mime.charset(type string)
Lookup the implied default charset of a content-type.
```golang
mime_db.charset('text/markdown') // 'UTF-8'
```
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## License
[MIT](LICENSE)
## Contributors
- [Ned Palacios](https://github.com/nedpals) - creator and maintainer