Détail du package

@zazuko/rdf-utils-fs

zazuko10.8kMIT3.3.1

RDF/JS file system utils

rdf, rdfjs, fs, utils

readme

@zazuko/rdf-utils-fs

Build Status npm version

File system utils for RDF/JS.

Usage with @zazuko/env-node (preferred)

@zazuko/env-node package extends @zazuko/env by including the fs utils and default parsers/serializers for simplest possible usage in node environment.

import rdf from '@zazuko/env-node'

// parse
const dataset = await env.dataset().import(env.fromFile(`/path/to/data.nt`))

// serialise
await env.toFile(dataset, `/path/to/data.json`)

Extend @zazuko/env yourself

import Environment from '@zazuko/env/Environment.js'
import baseEnv from '@zazuko/env`
import { FsUtilsFactory } from '@zazuko/rdf-utils-fs'
import fromStream from 'rdf-dataset-ext/fromStream.js'
import formats from '@rdfjs/formats'

// create an environment by adding FsUtilsFactory
const env = new Environment([FsUtilsFactory], { parent: baseEnv })
// add parsers+serializers
env.formats.import(formats)

// parse
const dataset = await env.dataset().import(env.fromFile(`/path/to/data.nt`))

// serialise
await env.toFile(dataset.toStream(), `/path/to/data.json`)

Usage with an existing environment

Same as above, but the RDF/JS Environment is provided as first argument. That environment must implement RDF/JS DataFactory, FormatsFactory.

import rdf from 'rdf-ext'
import { fromFile, toFile } from 'rdf-utils-fs'
import formats from '@rdfjs/formats'

// add parsers+serializers
rdf.formats.import(formats)

// parse
const parserStream = fromFile(rdf, `/path/to/data.nt`)
const dataset = await rdf.dataset().import(parserStream)

// serialise
await env.toFile(rdf, dataset, `/path/to/data.json`)

Functions

fromFile(filename, options)

Returns a quad stream for the given filename.

By default, the file is parsed without a base IRI. If you want to use the file's IRI as base, pass { implicitBaseIRI: true } as options.

async toFile(stream, filename, options)

Writes the given quad stream to filename.

changelog

@zazuko/rdf-utils-fs

3.3.1

Patch Changes

  • 41b6810: Remove FormatsFactory imported from @rdfjs/environment

3.3.0

Minor Changes

  • 170f9ae: Update @rdfjs/environment to v1
  • 170f9ae: Replace @rdfjs/formats-common with @rdfjs/formats

3.2.0

Minor Changes

  • 738dafa: Add an option to assume baseIRI to be the file:// of the document itself when parsing.

3.1.0

Minor Changes

  • ab46d14: Allow URL as path argument of toFile and fromFile

3.0.2

Patch Changes

  • 7062ab8: toFile was not types as async in factory

3.0.1

Patch Changes

  • 18d44d3: Restore @bergos as original author and have Zazuko as contributor

3.0.0

Major Changes

  • 199cbd4: Removed direct dependency on formats package which must be provided by RDF/JS Environment
  • 1406b72: Added new first argument in function toFile and fromFile which is an RDF/JS Enviornment
  • 3e2fef2: Hard fork from rdf-ext/rdf-utils-fs
  • 199cbd4: Convert package to ESM
  • 218ffc1: Add Factory compliant with RDF/JS

Minor Changes

  • 9ac9cec: Convert source code to TypeScript, bundle type declarations