import MetadataCollection from 'reptar/lib/collection/type/metadata.js'

public class | source

MetadataCollection

Extends:

CollectionBase → MetadataCollection

A collection that derives its content from a match in a files yaml frontmatter data.

Constructor Summary

Public Constructor
public	constructor(name: , collectionConfig: , config: , renderer: )

Member Summary

Public Members
public	metadataFiles: Object<string, Array<File>> Object which holds a mapping of metadata value to the files that contain the metadata property.
public	pages: *[]

Method Summary

Public Methods
public	addFile(file: File): boolean Add a file to the collection.
public	populate(files: Object<string, Files>): Collection Populate the Collection's files via file system path or metadata attribute.

Inherited Summary

From class CollectionBase
public static	sortFiles(files: Array<File>, sortConfig: Object, dateFormat: string): Array<file> Sorts files according to a sort config object.
public	data: Object Data accesible to templates.
public	id: string Unique ID of this Collection, currently its given name.
public	metadata: string Metadata attribute to use to find which items are within the collection.
public	name: string The collection name.
public	pageSize: number Size of each CollectionPage.
public	pages: Array<CollectionPage> Array of CollectionPage objects.
public	path: string Path where items belong within the collection.
public	permalink: Object Permalink information.
public	sort: Object Sorting configuration.
public	template: string What template to use when rendering a CollectionPage.
protected	_config: Config
protected	_renderer: Renderer
public	createPage(index: number, pageIdArg: string): CollectionPage Create a CollectionPage instance.
public	isFiltered(file: File): boolean Whether a File is filtered by the configured filters.
public	populate(files: Object<string, Files>, collections: Object<string, CollectionBase>): CollectionBase Populate the Collection's files via file system path or metadata attribute.
public	write(siteData: Object): Promise Writes every page in this collection.

Public Constructors

public constructor(name: , collectionConfig: , config: , renderer: ) source

Create a Collection instance.

Override:

CollectionBase#constructor

Params:

Name	Type	Attribute	Description
name	*
collectionConfig	*
config	*
renderer	*

Public Members

public metadataFiles: Object<string, Array<File>> source

Object which holds a mapping of metadata value to the files that contain the metadata property. For example with metadata of 'tags' you'd have: { 'tag-name': [file, file], 'other-tag': [file, file] }

public pages: *[] source

Array of CollectionPage objects.

Override:

CollectionBase#pages

Public Methods

public addFile(file: File): boolean source

Add a file to the collection.

Params:

Name	Type	Attribute	Description
file	File		File object.

Return:

boolean

True if the file was added to the collection.

public populate(files: Object<string, Files>): Collection source

Populate the Collection's files via file system path or metadata attribute.

Override:

CollectionBase#populate

Params:

Name	Type	Attribute	Description
files	Object<string, Files>		Object of files.

Return:

Collection

MetadataCollection

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(name: *, collectionConfig: *, config: *, renderer: *) source

Override:

Params:

Public Members

public metadataFiles: Object<string, Array<File>> source

public pages: *[] source

Override:

Public Methods

public addFile(file: File): boolean source

Params:

Return:

public populate(files: Object<string, Files>): Collection source

Override:

Params:

Return:

public constructor(name: , collectionConfig: , config: , renderer: ) source