Logo for jsDocs.io

gatsby-source-filesystem

  • Version 5.15.0
  • Published
  • 118 kB
  • 9 dependencies
  • MIT license

Install

npm i gatsby-source-filesystem
yarn add gatsby-source-filesystem
pnpm add gatsby-source-filesystem

Overview

Gatsby source plugin for building websites from local data. Markdown, JSON, images, YAML, CSV, and dozens of other data types supported.

Index

Functions

Interfaces

Functions

function createFileNodeFromBuffer

createFileNodeFromBuffer: (
    args: CreateFileNodeFromBufferArgs
) => Promise<FileSystemNode>;

  • See Also

    • https://www.gatsbyjs.com/plugins/gatsby-source-filesystem/?=files#createfilenodefrombuffer

function createFilePath

createFilePath: (args: CreateFilePathArgs) => string;

  • See Also

    • https://www.gatsbyjs.com/plugins/gatsby-source-filesystem/?=files#createfilepath

function createRemoteFileNode

createRemoteFileNode: (
    args: CreateRemoteFileNodeArgs
) => Promise<FileSystemNode>;

  • See Also

    • https://www.gatsbyjs.com/plugins/gatsby-source-filesystem/?=files#createremotefilenode

Interfaces

interface CreateFileNodeFromBufferArgs

interface CreateFileNodeFromBufferArgs {}

    property buffer

    buffer: Buffer;

      property cache

      cache?: GatsbyCache;

        property createNode

        createNode: Function;

          property createNodeId

          createNodeId: Function;

            property ext

            ext?: string;

              property getCache

              getCache?: Function;

                property hash

                hash?: string;

                  property name

                  name?: string;

                    property parentNodeId

                    parentNodeId?: string;

                      interface CreateFilePathArgs

                      interface CreateFilePathArgs {}

                        property basePath

                        basePath?: string;

                          property getNode

                          getNode: Function;

                            property node

                            node: Node;

                              property trailingSlash

                              trailingSlash?: boolean;

                                interface CreateRemoteFileNodeArgs

                                interface CreateRemoteFileNodeArgs {}

                                  property auth

                                  auth?: {
                                      htaccess_user: string;
                                      htaccess_pass: string;
                                  };

                                    property cache

                                    cache?: GatsbyCache;

                                      property createNode

                                      createNode: Function;

                                        property createNodeId

                                        createNodeId: Function;

                                          property ext

                                          ext?: string;

                                            property getCache

                                            getCache?: Function;

                                              property httpHeaders

                                              httpHeaders?: object;

                                                property name

                                                name?: string;

                                                  property parentNodeId

                                                  parentNodeId?: string;

                                                    property url

                                                    url: string;

                                                      interface FileSystemConfig

                                                      interface FileSystemConfig {}

                                                        property options

                                                        options: FileSystemOptions;

                                                          property resolve

                                                          resolve: 'gatsby-source-filesystem';

                                                            interface FileSystemNode

                                                            interface FileSystemNode extends Node {}

                                                              property absolutePath

                                                              absolutePath: string;

                                                                property accessTime

                                                                accessTime: string;

                                                                  property atime

                                                                  atime: Date;

                                                                    property atimeMs

                                                                    atimeMs: number;

                                                                      property base

                                                                      base: string;

                                                                        property birthtime

                                                                        birthtime: Date;

                                                                        • Deprecated

                                                                          Use birthTime instead

                                                                        property birthTime

                                                                        birthTime: Date;

                                                                          property birthtimeMs

                                                                          birthtimeMs: number;

                                                                          • Deprecated

                                                                            Use birthTime instead

                                                                          property changeTime

                                                                          changeTime: string;

                                                                            property ctime

                                                                            ctime: Date;

                                                                              property ctimeMs

                                                                              ctimeMs: number;

                                                                                property dir

                                                                                dir: string;

                                                                                  property ext

                                                                                  ext: string;

                                                                                    property extension

                                                                                    extension: string;

                                                                                      property gid

                                                                                      gid: number;

                                                                                        property mode

                                                                                        mode: number;

                                                                                          property modifiedTime

                                                                                          modifiedTime: string;

                                                                                            property mtime

                                                                                            mtime: Date;

                                                                                              property mtimeMs

                                                                                              mtimeMs: number;

                                                                                                property name

                                                                                                name: string;

                                                                                                  property prettySize

                                                                                                  prettySize: string;

                                                                                                    property relativeDirectory

                                                                                                    relativeDirectory: string;

                                                                                                      property relativePath

                                                                                                      relativePath: string;

                                                                                                        property root

                                                                                                        root: string;

                                                                                                          property size

                                                                                                          size: number;

                                                                                                            property sourceInstanceName

                                                                                                            sourceInstanceName: string;

                                                                                                              property uid

                                                                                                              uid: number;

                                                                                                                interface FileSystemOptions

                                                                                                                interface FileSystemOptions {}

                                                                                                                • See Also

                                                                                                                  • https://www.gatsbyjs.com/plugins/gatsby-source-filesystem/?=filesy#options

                                                                                                                property ignore

                                                                                                                ignore?: string[];

                                                                                                                  property name

                                                                                                                  name: string;

                                                                                                                    property path

                                                                                                                    path: string;

                                                                                                                      Package Files (1)

                                                                                                                      Dependencies (9)

                                                                                                                      Dev Dependencies (4)

                                                                                                                      Peer Dependencies (1)

                                                                                                                      Badge

                                                                                                                      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                                                      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/gatsby-source-filesystem.

                                                                                                                      • Markdown
                                                                                                                        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/gatsby-source-filesystem)
                                                                                                                      • HTML
                                                                                                                        <a href="https://www.jsdocs.io/package/gatsby-source-filesystem"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>