Member Junction
    Preparing search index...

    Type Alias FileSearchOptions

    Options for configuring a file search operation. These options allow for flexible, provider-agnostic search capabilities while still leveraging native provider search features where available.

    type FileSearchOptions = {
        fileTypes?: string[];
        maxResults?: number;
        modifiedAfter?: Date;
        modifiedBefore?: Date;
        pathPrefix?: string;
        providerSpecific?: Record<string, unknown>;
        searchContent?: boolean;
    }
    Index

    Properties

    fileTypes? maxResults? modifiedAfter? modifiedBefore? pathPrefix? providerSpecific? searchContent?

    Properties

    fileTypes?: string[]

    File types to include in search results. Examples: ['pdf', 'docx', 'xlsx'], ['image/*'], ['text/plain'] Can use MIME types or file extensions.

    maxResults?: number

    Maximum number of results to return. Defaults to 100 if not specified.

    modifiedAfter?: Date

    Only return files modified after this date.

    modifiedBefore?: Date

    Only return files modified before this date.

    pathPrefix?: string

    Restrict search to files within this path prefix. Example: 'documents/reports/' would only search within that directory.

    providerSpecific?: Record<string, unknown>

    Additional provider-specific search parameters. This allows providers to expose advanced features not covered by common options. Example: { 'trashed': false } for Google Drive, { 'scope': 'personal' } for SharePoint

    searchContent?: boolean

    Whether to search file contents in addition to names and metadata. Not all providers support content search. Defaults to false.

    Settings

    Member Visibility

    On This Page

    Properties