# Interface NoteParams

interface NoteParams {
branchId ?: string;
content : string | Buffer< ArrayBufferLike >;
dateCreated ?: string;
ignoreForbiddenParents ?: boolean;
isExpanded ?: boolean;
isProtected ?: boolean;
mime ?: string;
noteId ?: string;
notePosition ?: number;
parentNoteId : string;
prefix ?: string;
target ?: "into";
templateNoteId ?: string;
title : string;
type :
| "canvas"
| "code"
| "search"
| "image"
| "text"
| "file"
| "noteMap"
| "launcher"
| "doc"
| "contentWidget"
| "relationMap"
| "render"
| "mermaid"
| "book"
| "webView"
| "mindMap"
| "geoMap";
utcDateCreated ?: string;
}

- Defined in src/services/note-interface.ts:3

##### Index

### Properties

branchId?
content
dateCreated?
ignoreForbiddenParents?
isExpanded?
isProtected?
mime?
noteId?
notePosition?
parentNoteId
prefix?
target?
templateNoteId?
title
type
utcDateCreated?

## Properties

### `Optional` branchId

branchId?: string

- Defined in src/services/note-interface.ts:6

### content

content: string | Buffer< ArrayBufferLike >

- Defined in src/services/note-interface.ts:10

### `Optional` dateCreated

dateCreated?: string

- Defined in src/services/note-interface.ts:23

### `Optional` ignoreForbiddenParents

ignoreForbiddenParents?: boolean

- Defined in src/services/note-interface.ts:25

### `Optional` isExpanded

isExpanded?: boolean

default is false

- Defined in src/services/note-interface.ts:18

### `Optional` isProtected

isProtected?: boolean

default is false

- Defined in src/services/note-interface.ts:16

### `Optional` mime

mime?: string

default value is derived from default mimes for type

- Defined in src/services/note-interface.ts:14

### `Optional` noteId

noteId?: string

optionally can force specific noteId

- Defined in src/services/note-interface.ts:5

### `Optional` notePosition

notePosition?: number

default is the last existing notePosition in a parent + 10

- Defined in src/services/note-interface.ts:22

### parentNoteId

parentNoteId: string

- Defined in src/services/note-interface.ts:7

### `Optional` prefix

prefix?: string

default is empty string

- Defined in src/services/note-interface.ts:20

### `Optional` target

target?: "into"

- Defined in src/services/note-interface.ts:26

### `Optional` templateNoteId

templateNoteId?: string

- Defined in src/services/note-interface.ts:8

### title

title: string

- Defined in src/services/note-interface.ts:9

### type

type:
| "canvas"
| "code"
| "search"
| "image"
| "text"
| "file"
| "noteMap"
| "launcher"
| "doc"
| "contentWidget"
| "relationMap"
| "render"
| "mermaid"
| "book"
| "webView"
| "mindMap"
| "geoMap"

text, code, file, image, search, book, relationMap, canvas, webView

- Defined in src/services/note-interface.ts:12

### `Optional` utcDateCreated

utcDateCreated?: string

- Defined in src/services/note-interface.ts:24